From f6af60d9e63976d47faaf188baaf1e608f9b4ce2 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 14:05:05 -0700 Subject: [PATCH 01/16] initial proposal for merging spk --- technical-docs/designs/repos-merge.md | 267 ++++++++++++++++++++++++++ 1 file changed, 267 insertions(+) create mode 100644 technical-docs/designs/repos-merge.md diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md new file mode 100644 index 000000000..1b5440d10 --- /dev/null +++ b/technical-docs/designs/repos-merge.md @@ -0,0 +1,267 @@ +# Moving SPK to Bedrock Repo: A Phased Approach + +## Phase 1: Make Changes to Bedrock Repo + +Making following changes in existing Bedrock repo minimizes the number of +changes after the merge and limits the testing scope. + +### Current Bedrock Repo + +``` +├── .github +├── cluster +├── docs +├── gitops +├── pipelines +├── test +├── tools +├── LICESNE +├── README.md +├── .gitignore +├── azure-pipelines.yml +``` + +### Proposed Changes + +- Create `src` folder in `cluster` folder +- Move all files and folders except `src` from `cluster` to `cluster\src` +- Move `azure-pipelines.yml` file from the root to `cluster\build\pipelines` + directory and make sure all pipelines still works. +- Move `docs` folder to `cluster` folder and make sure all doc links works. +- Move `test` folder to `cluster` folder and make sure all tests and pipelines + still works. +- Move `tools` directory to `cluster\build` folder and make sure existing + Bedrock release process still works. +- [ ] Move following files form the `root` directory to `cluster` and make sure + `cluster` project can be opened in VS Code. + - LICESNE + - README.md + - .gitignore + +### Test + +After making the above changes, need to make sure that the follwing tests pass. + +- Verify the environments integration tests continue to work in `azdo` +- Verify all `docs` links work +- Verify `bedrock` release provess work +- Verify the project can be opened in VS Code from the `cluster` folder + +### Bedrock repo after changes + +`Bedrock` repo would look like below after implementing the above changes. + +``` +├── .github +├── gitops +├── cluster + ├── build + ├── pipelines + ├── azure-pipelines.yml + ├── tools + ├── docs + ├── src + ├── test + ├── LICESNE + ├── README.md + ├── .gitignore + +``` + +## Phase 2: Make Changes to SPK Repo + +Making following changes in existing SPK repo minimizes the number of changes +after the merge and limits the testing scope to SPK functioanlity. + +### Current SPK repo + +``` +├── .github +├── azure-pipelines + ├── templates +├── docs + ├── commands +├── guides +├── patches +├── scripts +├── src +├── technical-docs + ├── designs +├── tests +├── tools +├── typings + ├── ssh-url +├── .editorconfig +├── .env.example +├── .gitignore +├── CHANGELOG.md +├── README.md +├── azure-pipelines.yml +├── jest.config.js +├── package.json +├── release-pipeline.yml +├── smoke-test-pipeline.yml +├── spk-config.yaml +├── tsconfig.json +├── tslint.json +├── typings +├── webpack.config.js +├── .yarn.lock +``` + +### Themes + +The main themes are related to organizing `docs` and `build` related artifacts +in `spk` from the root to appropriate directories. + +1. Oragnize all pipeline yaml files, scripts, and tools that are related to + building and releasing binaries under `build` directory. + +2. Organize all docs that are related to using and contributing bedrock under + `docs` directory. + +### Proposed Changes + +The majority of the proposed changes in `spk` repo are related to organizing +`docs` and `build` folders. + +- Move following files from the `root` to `build\pipelines` folder and make sure + all pipelines continue to work. + - azure-pipelines.yml + - release-pipeline.yml + - smoke-test-pipeline.yml +- Move following files from the `scripts` to `build\tools` folder and verify the + scripts generate `command` docs. + - generateDoc.ts + - locateAliases.ts +- Move `patches` directory to `build\patches` folder and make sure `yarn build` + and `yarn test` continue to work. +- Move `azure-pipelines\templates` folder to `build\pipelines\templates` folder + and verify all pipelines continue to work. +- Move `guides\contributing.md` file to `docs\contribution` folder +- Move `guides` folder to `docs` folder +- Move `technical-docs\designs` to `docs\contribution\designs` folder + +### SPK repo after changes + +`spk` repo would look like below after implementing the above changes. + +``` +├── .github +├── build + ├── pipelines + ├── templates + ├── azure-pipelines.yml + ├── release-pipeline.yml + ├── smoke-test-pipeline.yml + ├── patches + ├── 001-azure-devops-node.patch + ├── tools + ├── generateDoc.ts + ├── locateAliases.ts + ├── release-version-bump.sh + ├── tag-release.sh + ├── update_introspection.sh +├── docs + ├── commands + ├── contribution + ├── contributing.md + ├── designs + ├── guides +├── src + ├── lib + ├── commands + ├── logger +├── tests +├── typings + ├── ssh-url +├── .editorconfig +├── .gitignore +├── jest.config.js +├── tsconfig.json +├── tslint.json +├── CHANGELOG.md +├── README.md +├── package.json +├── webpack.config.js +├── .yarn.lock +``` + +## Phase 3: Move SPK to Bedrock Repo + +Moving SPK repo to Bedrock involves following changes. + +### Activities + +- Move `.github\workflows` to `.github` folder in `bedrock` repo +- Update `.readme.md` in `bedrock` repo with contents from `spk` repo as + appropriate. Please note this is not a complete merge since it is a new + landing page of combined repos. +- Create or update `changelog.md` file. (_TBD_) +- Move all files and folder from the root of `spk` to `bedrock` root + +### Combined repo + +The combined `bedrock` repo would look like below after implementing the above +changes. + +``` +├── .github +├── gitops +├── cluster +├── build + ├── pipelines + ├── templates + ├── azure-pipelines.yml + ├── release-pipeline.yml + ├── smoke-test-pipeline.yml + ├── patches + ├── 001-azure-devops-node.patch + ├── tools + ├── generateDoc.ts + ├── locateAliases.ts + ├── release-version-bump.sh + ├── tag-release.sh + ├── update_introspection.sh +├── docs + ├── commands + ├── contribution + ├── contributing.md + ├── designs + ├── guides +├── src + ├── lib + ├── commands + ├── logger +├── tests +├── typings + ├── ssh-url +├── .editorconfig +├── .gitignore +├── jest.config.js +├── tsconfig.json +├── tslint.json +├── CHANGELOG.md +├── README.md +├── package.json +├── webpack.config.js +├── .yarn.lock +``` + +### Next Steps + +At this point we can allow the codebase to stabilize for a while. Once we are +confident that things are working we can enter the 4th phase of post merge +changes + +## Phase 4: Post merge organization + +- Evaluate the contents of `gitops` folder and move contents to appropriate + folders +- Move all `*.md` in `gitops` folder to `docs\gitops` folder +- Move all `*.sh` and other script files in `gitops` folder to `build\tools` + folder + +## Phase 5: Create a side by side new repo for Bedrock Infra Terraform + +TODO From 1912637ab3dbdcf79872e9f0ecf46c82755c4156 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 14:10:40 -0700 Subject: [PATCH 02/16] added testing section in phase 2 --- technical-docs/designs/repos-merge.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 1b5440d10..53c32de68 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -2,7 +2,7 @@ ## Phase 1: Make Changes to Bedrock Repo -Making following changes in existing Bedrock repo minimizes the number of +By making following changes in existing Bedrock repo minimizes the number of changes after the merge and limits the testing scope. ### Current Bedrock Repo @@ -38,7 +38,7 @@ changes after the merge and limits the testing scope. - README.md - .gitignore -### Test +### Testing Changes After making the above changes, need to make sure that the follwing tests pass. @@ -142,6 +142,16 @@ The majority of the proposed changes in `spk` repo are related to organizing - Move `guides` folder to `docs` folder - Move `technical-docs\designs` to `docs\contribution\designs` folder +### Testing Changes + +After making the above changes, need to make sure that the follwing tests pass. + +- Verify cli build pipeline is working +- Verify cli integration test pipeline is working +- Verify cli release pipeline is working +- Verify cli autogenerated docs are working on GitHub pages +- Verify all docs links are working + ### SPK repo after changes `spk` repo would look like below after implementing the above changes. From acb88f69e5fbe1c1bc512384aabe3a4ba30428d4 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 14:12:50 -0700 Subject: [PATCH 03/16] updated wording in phase 4 --- technical-docs/designs/repos-merge.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 53c32de68..50f9ae7c9 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -268,9 +268,8 @@ changes - Evaluate the contents of `gitops` folder and move contents to appropriate folders -- Move all `*.md` in `gitops` folder to `docs\gitops` folder -- Move all `*.sh` and other script files in `gitops` folder to `build\tools` - folder +- Move all `*.md` files from `gitops` folder to `docs\gitops` folder +- Move all `*.sh` script files from `gitops` folder to `build\tools` folder ## Phase 5: Create a side by side new repo for Bedrock Infra Terraform From 1685d306934b2be14654db7876892bd42e47b3c8 Mon Sep 17 00:00:00 2001 From: Andre Briggs Date: Thu, 12 Mar 2020 14:59:11 -0700 Subject: [PATCH 04/16] Update repos-merge.md Merging Phase 1 and 2 --- technical-docs/designs/repos-merge.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 50f9ae7c9..484e1641f 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -1,6 +1,7 @@ # Moving SPK to Bedrock Repo: A Phased Approach -## Phase 1: Make Changes to Bedrock Repo +## Phase 1: Make Changes to Bedrock and SPK Repos +**Make Changes to Bedrock Repo** By making following changes in existing Bedrock repo minimizes the number of changes after the merge and limits the testing scope. @@ -15,7 +16,7 @@ changes after the merge and limits the testing scope. ├── pipelines ├── test ├── tools -├── LICESNE +├── LICENSE ├── README.md ├── .gitignore ├── azure-pipelines.yml @@ -34,7 +35,7 @@ changes after the merge and limits the testing scope. Bedrock release process still works. - [ ] Move following files form the `root` directory to `cluster` and make sure `cluster` project can be opened in VS Code. - - LICESNE + - LICENSE - README.md - .gitignore @@ -62,13 +63,13 @@ After making the above changes, need to make sure that the follwing tests pass. ├── docs ├── src ├── test - ├── LICESNE + ├── LICENSE ├── README.md ├── .gitignore ``` -## Phase 2: Make Changes to SPK Repo +**Make Changes to SPK Repo** Making following changes in existing SPK repo minimizes the number of changes after the merge and limits the testing scope to SPK functioanlity. @@ -197,7 +198,7 @@ After making the above changes, need to make sure that the follwing tests pass. ├── .yarn.lock ``` -## Phase 3: Move SPK to Bedrock Repo +## Phase 2: Move SPK to Bedrock Repo Moving SPK repo to Bedrock involves following changes. @@ -264,13 +265,13 @@ At this point we can allow the codebase to stabilize for a while. Once we are confident that things are working we can enter the 4th phase of post merge changes -## Phase 4: Post merge organization +## Phase 3: Post merge organization - Evaluate the contents of `gitops` folder and move contents to appropriate folders - Move all `*.md` files from `gitops` folder to `docs\gitops` folder - Move all `*.sh` script files from `gitops` folder to `build\tools` folder -## Phase 5: Create a side by side new repo for Bedrock Infra Terraform +## Phase 4: Create a side by side new repo for Bedrock Infra Terraform TODO From 6b7ebc94bb506f0d13f05e160389c09785c3f1ca Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 15:20:45 -0700 Subject: [PATCH 05/16] updated sections --- technical-docs/designs/repos-merge.md | 36 +++++++++++++-------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 484e1641f..c3a1f1f89 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -1,12 +1,13 @@ # Moving SPK to Bedrock Repo: A Phased Approach ## Phase 1: Make Changes to Bedrock and SPK Repos -**Make Changes to Bedrock Repo** + +### Changes to Bedrock Repo By making following changes in existing Bedrock repo minimizes the number of changes after the merge and limits the testing scope. -### Current Bedrock Repo +#### Current Bedrock Repo ``` ├── .github @@ -22,7 +23,7 @@ changes after the merge and limits the testing scope. ├── azure-pipelines.yml ``` -### Proposed Changes +#### Proposed Changes - Create `src` folder in `cluster` folder - Move all files and folders except `src` from `cluster` to `cluster\src` @@ -39,7 +40,7 @@ changes after the merge and limits the testing scope. - README.md - .gitignore -### Testing Changes +#### Testing Changes After making the above changes, need to make sure that the follwing tests pass. @@ -48,7 +49,7 @@ After making the above changes, need to make sure that the follwing tests pass. - Verify `bedrock` release provess work - Verify the project can be opened in VS Code from the `cluster` folder -### Bedrock repo after changes +#### Bedrock repo after changes `Bedrock` repo would look like below after implementing the above changes. @@ -69,12 +70,12 @@ After making the above changes, need to make sure that the follwing tests pass. ``` -**Make Changes to SPK Repo** +### Changes to SPK Repo Making following changes in existing SPK repo minimizes the number of changes after the merge and limits the testing scope to SPK functioanlity. -### Current SPK repo +#### Current SPK repo ``` ├── .github @@ -110,7 +111,7 @@ after the merge and limits the testing scope to SPK functioanlity. ├── .yarn.lock ``` -### Themes +#### Themes The main themes are related to organizing `docs` and `build` related artifacts in `spk` from the root to appropriate directories. @@ -121,7 +122,7 @@ in `spk` from the root to appropriate directories. 2. Organize all docs that are related to using and contributing bedrock under `docs` directory. -### Proposed Changes +#### Proposed Changes The majority of the proposed changes in `spk` repo are related to organizing `docs` and `build` folders. @@ -142,8 +143,9 @@ The majority of the proposed changes in `spk` repo are related to organizing - Move `guides\contributing.md` file to `docs\contribution` folder - Move `guides` folder to `docs` folder - Move `technical-docs\designs` to `docs\contribution\designs` folder +- Remove `.github\workflows` folder since it is not being used -### Testing Changes +#### Testing Changes After making the above changes, need to make sure that the follwing tests pass. @@ -153,12 +155,11 @@ After making the above changes, need to make sure that the follwing tests pass. - Verify cli autogenerated docs are working on GitHub pages - Verify all docs links are working -### SPK repo after changes +#### SPK repo after changes `spk` repo would look like below after implementing the above changes. ``` -├── .github ├── build ├── pipelines ├── templates @@ -204,7 +205,6 @@ Moving SPK repo to Bedrock involves following changes. ### Activities -- Move `.github\workflows` to `.github` folder in `bedrock` repo - Update `.readme.md` in `bedrock` repo with contents from `spk` repo as appropriate. Please note this is not a complete merge since it is a new landing page of combined repos. @@ -218,7 +218,7 @@ changes. ``` ├── .github -├── gitops +├── gitops ├── cluster ├── build ├── pipelines @@ -261,9 +261,9 @@ changes. ### Next Steps -At this point we can allow the codebase to stabilize for a while. Once we are -confident that things are working we can enter the 4th phase of post merge -changes +At this point we can allow the codebase to stabilize for a while before +implementing phase 4. Once we are confident that things are working we can enter +the 4th phase of post merge changes. ## Phase 3: Post merge organization @@ -272,6 +272,6 @@ changes - Move all `*.md` files from `gitops` folder to `docs\gitops` folder - Move all `*.sh` script files from `gitops` folder to `build\tools` folder -## Phase 4: Create a side by side new repo for Bedrock Infra Terraform +## Phase 4: Create a side by side new repo for Bedrock Infra/Cluster terraform TODO From 307c070d79fa81d2fbde3355bfb266e2af6a8232 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 15:24:27 -0700 Subject: [PATCH 06/16] testing colors --- technical-docs/designs/repos-merge.md | 50 +++++++++++++-------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index c3a1f1f89..097e01842 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -216,12 +216,12 @@ Moving SPK repo to Bedrock involves following changes. The combined `bedrock` repo would look like below after implementing the above changes. -``` -├── .github -├── gitops -├── cluster -├── build - ├── pipelines +```diff +# ├── .github +# ├── gitops +! ├── cluster ++ ├── build + ├── pipelines ├── templates ├── azure-pipelines.yml ├── release-pipeline.yml @@ -234,29 +234,29 @@ changes. ├── release-version-bump.sh ├── tag-release.sh ├── update_introspection.sh -├── docs - ├── commands - ├── contribution - ├── contributing.md - ├── designs - ├── guides -├── src ++ ├── docs + ├── commands + ├── contribution + ├── contributing.md + ├── designs + ├── guides +# ├── src ├── lib ├── commands ├── logger -├── tests -├── typings ++ ├── tests ++ ├── typings ├── ssh-url -├── .editorconfig -├── .gitignore -├── jest.config.js -├── tsconfig.json -├── tslint.json -├── CHANGELOG.md -├── README.md -├── package.json -├── webpack.config.js -├── .yarn.lock ++ ├── .editorconfig ++ ├── .gitignore ++ ├── jest.config.js ++ ├── tsconfig.json ++ ├── tslint.json ++ ├── CHANGELOG.md ++ ├── README.md ++ ├── package.json ++ ├── webpack.config.js ++ ├── .yarn.lock ``` ### Next Steps From ce5b9772bf6bbc10fa78a9b2076e410c99050fe6 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 15:34:32 -0700 Subject: [PATCH 07/16] testing colors --- technical-docs/designs/repos-merge.md | 54 +++++++++++++++------------ 1 file changed, 31 insertions(+), 23 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 097e01842..cf6d339a4 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -216,37 +216,45 @@ Moving SPK repo to Bedrock involves following changes. The combined `bedrock` repo would look like below after implementing the above changes. +#### Legend + +```diff +# - no change from the merge process ++ - came from `spk` repo +! - organized in `bedrock` repo changes before merge +``` + ```diff # ├── .github # ├── gitops ! ├── cluster + ├── build - ├── pipelines - ├── templates - ├── azure-pipelines.yml - ├── release-pipeline.yml - ├── smoke-test-pipeline.yml - ├── patches - ├── 001-azure-devops-node.patch - ├── tools - ├── generateDoc.ts - ├── locateAliases.ts - ├── release-version-bump.sh - ├── tag-release.sh - ├── update_introspection.sh + + ├── pipelines + + ├── templates + + ├── azure-pipelines.yml + + ├── release-pipeline.yml + + ├── smoke-test-pipeline.yml + + ├── patches + + ├── 001-azure-devops-node.patch + + ├── tools + + ├── generateDoc.ts + + ├── locateAliases.ts + + ├── release-version-bump.sh + + ├── tag-release.sh + + ├── update_introspection.sh + ├── docs - ├── commands - ├── contribution - ├── contributing.md - ├── designs - ├── guides -# ├── src - ├── lib - ├── commands - ├── logger + + ├── commands + + ├── contribution + + ├── contributing.md + + ├── designs + + ├── guides ++ ├── src + + ├── lib + + ├── commands + + ├── logger + ├── tests + ├── typings - ├── ssh-url + + ├── ssh-url + ├── .editorconfig + ├── .gitignore + ├── jest.config.js From e885cf86f9fb98a8e042847ca62dcbeb125986e7 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 15:49:53 -0700 Subject: [PATCH 08/16] testing colors --- technical-docs/designs/repos-merge.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index cf6d339a4..7ec916289 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -216,15 +216,15 @@ Moving SPK repo to Bedrock involves following changes. The combined `bedrock` repo would look like below after implementing the above changes. -#### Legend +_color legend:_ ```diff # - no change from the merge process + - came from `spk` repo -! - organized in `bedrock` repo changes before merge +! - changed before merge in `bedrock` repo ``` -```diff +````diff # ├── .github # ├── gitops ! ├── cluster @@ -254,7 +254,7 @@ changes. + ├── logger + ├── tests + ├── typings - + ├── ssh-url + ```diff + ├── ssh-url``` + ├── .editorconfig + ├── .gitignore + ├── jest.config.js @@ -265,7 +265,7 @@ changes. + ├── package.json + ├── webpack.config.js + ├── .yarn.lock -``` +```` ### Next Steps From a6bd8d96d134d70bc26d4b09a461fbd42eb6f575 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Thu, 12 Mar 2020 15:54:24 -0700 Subject: [PATCH 09/16] testing colors --- technical-docs/designs/repos-merge.md | 50 +++++++++++++-------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 7ec916289..423c8570b 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -220,41 +220,41 @@ _color legend:_ ```diff # - no change from the merge process -+ - came from `spk` repo ++ - all files and folders including sub folders came from `spk` repo ! - changed before merge in `bedrock` repo ``` -````diff +```diff # ├── .github # ├── gitops ! ├── cluster + ├── build - + ├── pipelines - + ├── templates - + ├── azure-pipelines.yml - + ├── release-pipeline.yml - + ├── smoke-test-pipeline.yml - + ├── patches - + ├── 001-azure-devops-node.patch - + ├── tools - + ├── generateDoc.ts - + ├── locateAliases.ts - + ├── release-version-bump.sh - + ├── tag-release.sh - + ├── update_introspection.sh + ├── pipelines + ├── templates + ├── azure-pipelines.yml + ├── release-pipeline.yml + ├── smoke-test-pipeline.yml + ├── patches + ├── 001-azure-devops-node.patch + ├── tools + ├── generateDoc.ts + ├── locateAliases.ts + ├── release-version-bump.sh + ├── tag-release.sh + ├── update_introspection.sh + ├── docs - + ├── commands - + ├── contribution - + ├── contributing.md - + ├── designs - + ├── guides + ├── commands + ├── contribution + ├── contributing.md + ├── designs + ├── guides + ├── src - + ├── lib - + ├── commands - + ├── logger + ├── lib + ├── commands + ├── logger + ├── tests + ├── typings - ```diff + ├── ssh-url``` + ├── ssh-url + ├── .editorconfig + ├── .gitignore + ├── jest.config.js @@ -265,7 +265,7 @@ _color legend:_ + ├── package.json + ├── webpack.config.js + ├── .yarn.lock -```` +``` ### Next Steps From 7458c7c20c74a1de4b495b9e9602d67e9e4b4b29 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Mon, 16 Mar 2020 10:43:57 -0700 Subject: [PATCH 10/16] Updated with the feedback --- technical-docs/designs/repos-merge.md | 59 +++++++++++++-------------- 1 file changed, 28 insertions(+), 31 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 423c8570b..6a63be7aa 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -29,15 +29,13 @@ changes after the merge and limits the testing scope. - Move all files and folders except `src` from `cluster` to `cluster\src` - Move `azure-pipelines.yml` file from the root to `cluster\build\pipelines` directory and make sure all pipelines still works. -- Move `docs` folder to `cluster` folder and make sure all doc links works. - Move `test` folder to `cluster` folder and make sure all tests and pipelines still works. -- Move `tools` directory to `cluster\build` folder and make sure existing - Bedrock release process still works. +- Move `bedrock` related files from `tools` directory to `cluster\build` folder + and make sure existing Bedrock release process still works. - [ ] Move following files form the `root` directory to `cluster` and make sure `cluster` project can be opened in VS Code. - LICENSE - - README.md - .gitignore #### Testing Changes @@ -45,7 +43,6 @@ changes after the merge and limits the testing scope. After making the above changes, need to make sure that the follwing tests pass. - Verify the environments integration tests continue to work in `azdo` -- Verify all `docs` links work - Verify `bedrock` release provess work - Verify the project can be opened in VS Code from the `cluster` folder @@ -116,7 +113,7 @@ after the merge and limits the testing scope to SPK functioanlity. The main themes are related to organizing `docs` and `build` related artifacts in `spk` from the root to appropriate directories. -1. Oragnize all pipeline yaml files, scripts, and tools that are related to +1. Organize all pipeline yaml files, scripts, and tools that are related to building and releasing binaries under `build` directory. 2. Organize all docs that are related to using and contributing bedrock under @@ -132,8 +129,8 @@ The majority of the proposed changes in `spk` repo are related to organizing - azure-pipelines.yml - release-pipeline.yml - smoke-test-pipeline.yml -- Move following files from the `scripts` to `build\tools` folder and verify the - scripts generate `command` docs. +- Move following files from the `scripts` to `build\publishing` folder and + verify the scripts generate `command` docs. - generateDoc.ts - locateAliases.ts - Move `patches` directory to `build\patches` folder and make sure `yarn build` @@ -199,7 +196,7 @@ After making the above changes, need to make sure that the follwing tests pass. ├── .yarn.lock ``` -## Phase 2: Move SPK to Bedrock Repo +## Phase 2: Move SPK to Bedrock Repo (under review) Moving SPK repo to Bedrock involves following changes. @@ -229,32 +226,32 @@ _color legend:_ # ├── gitops ! ├── cluster + ├── build - ├── pipelines - ├── templates - ├── azure-pipelines.yml - ├── release-pipeline.yml - ├── smoke-test-pipeline.yml - ├── patches - ├── 001-azure-devops-node.patch - ├── tools - ├── generateDoc.ts - ├── locateAliases.ts - ├── release-version-bump.sh - ├── tag-release.sh - ├── update_introspection.sh ++ ├── pipelines ++ ├── templates ++ ├── azure-pipelines.yml ++ ├── release-pipeline.yml ++ ├── smoke-test-pipeline.yml ++ ├── patches ++ ├── 001-azure-devops-node.patch ++ ├── tools ++ ├── generateDoc.ts ++ ├── locateAliases.ts ++ ├── release-version-bump.sh ++ ├── tag-release.sh ++ ├── update_introspection.sh + ├── docs - ├── commands - ├── contribution - ├── contributing.md - ├── designs - ├── guides ++ ├── commands ++ ├── contribution ++ ├── contributing.md ++ ├── designs ++ ├── guides + ├── src - ├── lib - ├── commands - ├── logger ++ ├── lib ++ ├── commands ++ ├── logger + ├── tests + ├── typings - ├── ssh-url ++ ├── ssh-url + ├── .editorconfig + ├── .gitignore + ├── jest.config.js From 0997ff4f1a86841655225d209d881f6fbd5d742c Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Mon, 16 Mar 2020 10:49:32 -0700 Subject: [PATCH 11/16] Added publishing dir --- technical-docs/designs/repos-merge.md | 1 + 1 file changed, 1 insertion(+) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 6a63be7aa..9f2d8da4d 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -165,6 +165,7 @@ After making the above changes, need to make sure that the follwing tests pass. ├── smoke-test-pipeline.yml ├── patches ├── 001-azure-devops-node.patch + ├── publishing ├── tools ├── generateDoc.ts ├── locateAliases.ts From 6845c07d8dc5b9de613f648ff00e7a7b4a1a8536 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Mon, 16 Mar 2020 11:06:03 -0700 Subject: [PATCH 12/16] Added publishing dir --- technical-docs/designs/repos-merge.md | 41 ++++++++++++++------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 9f2d8da4d..4d0cce503 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -228,28 +228,29 @@ _color legend:_ ! ├── cluster + ├── build + ├── pipelines -+ ├── templates -+ ├── azure-pipelines.yml -+ ├── release-pipeline.yml -+ ├── smoke-test-pipeline.yml -+ ├── patches -+ ├── 001-azure-devops-node.patch -+ ├── tools -+ ├── generateDoc.ts -+ ├── locateAliases.ts -+ ├── release-version-bump.sh -+ ├── tag-release.sh -+ ├── update_introspection.sh ++ ├── templates ++ ├── azure-pipelines.yml ++ ├── release-pipeline.yml ++ ├── smoke-test-pipeline.yml ++ ├── patches ++ ├── 001-azure-devops-node.patch ++ ├── publishing ++ ├── tools ++ ├── generateDoc.ts ++ ├── locateAliases.ts ++ ├── release-version-bump.sh ++ ├── tag-release.sh ++ ├── update_introspection.sh + ├── docs -+ ├── commands -+ ├── contribution -+ ├── contributing.md -+ ├── designs -+ ├── guides ++ ├── commands ++ ├── contribution ++ ├── contributing.md ++ ├── designs ++ ├── guides + ├── src -+ ├── lib -+ ├── commands -+ ├── logger ++ ├── lib ++ ├── commands ++ ├── logger + ├── tests + ├── typings + ├── ssh-url From 4c26cb61fbb031488a9a6a49368fdd5bc4c23967 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Tue, 17 Mar 2020 13:07:16 -0700 Subject: [PATCH 13/16] Incorporated feedback --- technical-docs/designs/repos-merge.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 4d0cce503..5e7aadf60 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -137,9 +137,9 @@ The majority of the proposed changes in `spk` repo are related to organizing and `yarn test` continue to work. - Move `azure-pipelines\templates` folder to `build\pipelines\templates` folder and verify all pipelines continue to work. -- Move `guides\contributing.md` file to `docs\contribution` folder -- Move `guides` folder to `docs` folder -- Move `technical-docs\designs` to `docs\contribution\designs` folder +- Move `guides\contributing.md` file to `documents\contribution` folder +- Move `guides` folder to `documents` folder +- Move `technical-docs\designs` to `documents\contribution\designs` folder - Remove `.github\workflows` folder since it is not being used #### Testing Changes @@ -164,16 +164,17 @@ After making the above changes, need to make sure that the follwing tests pass. ├── release-pipeline.yml ├── smoke-test-pipeline.yml ├── patches - ├── 001-azure-devops-node.patch + ├── 001-azure-devops-node.patch ├── publishing + ├── generateDoc.ts + ├── locateAliases.ts ├── tools - ├── generateDoc.ts - ├── locateAliases.ts - ├── release-version-bump.sh - ├── tag-release.sh - ├── update_introspection.sh + ├── release-version-bump.sh + ├── tag-release.sh + ├── update_introspection.sh ├── docs ├── commands +├── documents ├── contribution ├── contributing.md ├── designs @@ -235,14 +236,15 @@ _color legend:_ + ├── patches + ├── 001-azure-devops-node.patch + ├── publishing -+ ├── tools + ├── generateDoc.ts + ├── locateAliases.ts ++ ├── tools + ├── release-version-bump.sh + ├── tag-release.sh + ├── update_introspection.sh + ├── docs + ├── commands ++ ├── documents + ├── contribution + ├── contributing.md + ├── designs @@ -276,7 +278,7 @@ the 4th phase of post merge changes. - Evaluate the contents of `gitops` folder and move contents to appropriate folders -- Move all `*.md` files from `gitops` folder to `docs\gitops` folder +- Move all `*.md` files from `gitops` folder to `documents\gitops` folder - Move all `*.sh` script files from `gitops` folder to `build\tools` folder ## Phase 4: Create a side by side new repo for Bedrock Infra/Cluster terraform From 92b2cee089d2c82f96475e22c3b3e5dc10d708fa Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Fri, 20 Mar 2020 10:23:37 -0700 Subject: [PATCH 14/16] removed additional phases to address in a future task --- technical-docs/designs/repos-merge.md | 95 +++------------------------ 1 file changed, 8 insertions(+), 87 deletions(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 5e7aadf60..8e8bd27fe 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -1,8 +1,8 @@ # Moving SPK to Bedrock Repo: A Phased Approach -## Phase 1: Make Changes to Bedrock and SPK Repos +## Phase 1: Prep work before moving SPK to Bedrock Repo -### Changes to Bedrock Repo +### Bedrock Repo Changes By making following changes in existing Bedrock repo minimizes the number of changes after the merge and limits the testing scope. @@ -38,7 +38,7 @@ changes after the merge and limits the testing scope. - LICENSE - .gitignore -#### Testing Changes +#### Testing After making the above changes, need to make sure that the follwing tests pass. @@ -67,7 +67,7 @@ After making the above changes, need to make sure that the follwing tests pass. ``` -### Changes to SPK Repo +### SPK Repo Changes Making following changes in existing SPK repo minimizes the number of changes after the merge and limits the testing scope to SPK functioanlity. @@ -142,7 +142,7 @@ The majority of the proposed changes in `spk` repo are related to organizing - Move `technical-docs\designs` to `documents\contribution\designs` folder - Remove `.github\workflows` folder since it is not being used -#### Testing Changes +#### Testing After making the above changes, need to make sure that the follwing tests pass. @@ -198,89 +198,10 @@ After making the above changes, need to make sure that the follwing tests pass. ├── .yarn.lock ``` -## Phase 2: Move SPK to Bedrock Repo (under review) +### Phase 2: Move SPK to Bedrock Repo (under review) -Moving SPK repo to Bedrock involves following changes. - -### Activities - -- Update `.readme.md` in `bedrock` repo with contents from `spk` repo as - appropriate. Please note this is not a complete merge since it is a new - landing page of combined repos. -- Create or update `changelog.md` file. (_TBD_) -- Move all files and folder from the root of `spk` to `bedrock` root - -### Combined repo - -The combined `bedrock` repo would look like below after implementing the above -changes. - -_color legend:_ - -```diff -# - no change from the merge process -+ - all files and folders including sub folders came from `spk` repo -! - changed before merge in `bedrock` repo -``` - -```diff -# ├── .github -# ├── gitops -! ├── cluster -+ ├── build -+ ├── pipelines -+ ├── templates -+ ├── azure-pipelines.yml -+ ├── release-pipeline.yml -+ ├── smoke-test-pipeline.yml -+ ├── patches -+ ├── 001-azure-devops-node.patch -+ ├── publishing -+ ├── generateDoc.ts -+ ├── locateAliases.ts -+ ├── tools -+ ├── release-version-bump.sh -+ ├── tag-release.sh -+ ├── update_introspection.sh -+ ├── docs -+ ├── commands -+ ├── documents -+ ├── contribution -+ ├── contributing.md -+ ├── designs -+ ├── guides -+ ├── src -+ ├── lib -+ ├── commands -+ ├── logger -+ ├── tests -+ ├── typings -+ ├── ssh-url -+ ├── .editorconfig -+ ├── .gitignore -+ ├── jest.config.js -+ ├── tsconfig.json -+ ├── tslint.json -+ ├── CHANGELOG.md -+ ├── README.md -+ ├── package.json -+ ├── webpack.config.js -+ ├── .yarn.lock -``` - -### Next Steps - -At this point we can allow the codebase to stabilize for a while before -implementing phase 4. Once we are confident that things are working we can enter -the 4th phase of post merge changes. - -## Phase 3: Post merge organization - -- Evaluate the contents of `gitops` folder and move contents to appropriate - folders -- Move all `*.md` files from `gitops` folder to `documents\gitops` folder -- Move all `*.sh` script files from `gitops` folder to `build\tools` folder +TODO -## Phase 4: Create a side by side new repo for Bedrock Infra/Cluster terraform +### Phase 3: Create a side by side new repo for Bedrock Infra/Cluster terraform TODO From 84689a11fcf0a6b288ea72374e2be8616be4b2f2 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Fri, 20 Mar 2020 10:31:27 -0700 Subject: [PATCH 15/16] updated section --- technical-docs/designs/repos-merge.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/technical-docs/designs/repos-merge.md b/technical-docs/designs/repos-merge.md index 8e8bd27fe..7d80880ef 100644 --- a/technical-docs/designs/repos-merge.md +++ b/technical-docs/designs/repos-merge.md @@ -198,7 +198,7 @@ After making the above changes, need to make sure that the follwing tests pass. ├── .yarn.lock ``` -### Phase 2: Move SPK to Bedrock Repo (under review) +### Phase 2: Move SPK to Bedrock Repo TODO From d6bb8f5680a682b02c61d6a8b69f5b3ac360a4b0 Mon Sep 17 00:00:00 2001 From: Sarath Pinninty Date: Mon, 23 Mar 2020 09:47:42 -0700 Subject: [PATCH 16/16] reverting a file --- src/commands/deployment/dashboard.test.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/commands/deployment/dashboard.test.ts b/src/commands/deployment/dashboard.test.ts index 5bfb6c5c0..7a8d64c8e 100644 --- a/src/commands/deployment/dashboard.test.ts +++ b/src/commands/deployment/dashboard.test.ts @@ -30,18 +30,18 @@ afterAll(() => { const mockConfig = (): void => { (Config as jest.Mock).mockReturnValueOnce({ - azure_devops: { - access_token: uuid(), + "azure_devops": { + "access_token": uuid(), org: uuid(), project: uuid() }, introspection: { azure: { - account_name: uuid(), + "account_name": uuid(), key: uuid(), - partition_key: uuid(), - source_repo_access_token: "test_token", - table_name: uuid() + "partition_key": uuid(), + "source_repo_access_token": "test_token", + "table_name": uuid() } } }); @@ -208,8 +208,8 @@ describe("Fallback to azure devops access token", () => { describe("Extract manifest repository information", () => { test("Manifest repository information is successfully extracted", () => { (Config as jest.Mock).mockReturnValue({ - azure_devops: { - manifest_repository: + "azure_devops": { + "manifest_repository": "https://dev.azure.com/bhnook/fabrikam/_git/materialized" } });