From 1d4577056529610774435ed440cf90f927d6e2f5 Mon Sep 17 00:00:00 2001 From: Ksawery Zietara Date: Thu, 22 Aug 2024 12:32:14 +0200 Subject: [PATCH 1/4] Update release documentation --- docs/assets/release.drawio | 394 ------------------------------ docs/assets/release.drawio.svg | 4 + docs/assets/release.svg | 4 - docs/contributor/03-10-release.md | 15 +- 4 files changed, 11 insertions(+), 406 deletions(-) delete mode 100644 docs/assets/release.drawio create mode 100644 docs/assets/release.drawio.svg delete mode 100644 docs/assets/release.svg diff --git a/docs/assets/release.drawio b/docs/assets/release.drawio deleted file mode 100644 index e885e524a..000000000 --- a/docs/assets/release.drawio +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/assets/release.drawio.svg b/docs/assets/release.drawio.svg new file mode 100644 index 000000000..327d00735 --- /dev/null +++ b/docs/assets/release.drawio.svg @@ -0,0 +1,4 @@ + + + +
GitHub Actions
GitHub Actions
GitHub Actions
GitHub Actions
unit tests job
unit tests job
unit tests job
unit tests job
stress tests
E2E tests jobs
stress tests...
E2E tests jobs
E2E tests jobs
GitHub repository
GitHub repository
GitHub repository
GitHub repository
image builders
image builders
image builders
image builders
Docker registry
Docker registry
Docker registry
Docker registry
Create a release
Create a release
initiate
initiate
fetch binary image, module image
fetch binary image, module image
uploads binary 
image
uploads binary...
9
9
initiate
initiate
3
3
6
6
7
7
validate release job
validate release job
bump security
 scanner config job
bump security...
initiate
initiate
2
2
returns result
returns result
returns PR to approve
returns PR to approve
initiates
initiates
1
1
approves PR
approves PR
4
4
returns result
returns result
create tag and draft release
create tag and draft release
5
5
initiate
initiate
6
6
returns result
returns result
initiate
initiate
8
8
returns result
returns result
publish release
publish release
10
10
bump security
 scanner config job
bump security...
validate release job
validate release job
returns result
returns resultText is not SVG - cannot display \ No newline at end of file diff --git a/docs/assets/release.svg b/docs/assets/release.svg deleted file mode 100644 index 78d82bc6d..000000000 --- a/docs/assets/release.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
GitHub Actions
GitHub Actions
GitHub Actions
GitHub Actions
unit tests job
unit tests job
unit tests job
unit tests job
stress tests
E2E tests jobs
stress tests...
E2E tests jobs
E2E tests jobs
GitHub repository
GitHub repository
GitHub repository
GitHub repository
post-btp-manager-build
post-btp-manager-bui...
post-btp-manager-build
post-btp-manager-bui...
Docker registry
Docker registry
Docker registry
Docker registry
Create a release
Create a release
triggers building binary image
triggers building...
fetch binary image, module image
fetch binary image, module image
uploads binary image
uploads binary image
10
10
initiate
initiate
3
3
7
7
8
8
validate release job
validate release job
bump security
 scanner config job
bump security...
await for Prow jobs status job
await for Prow jobs...
initiate
initiate
2
2
returns result
returns result
returns PR to approve
returns PR to approve
initiates
initiates
1
1
approves PR
approves PR
4
4
returns result
returns result
create tag and draft release
create tag and draft release
5
5
initiate
initiate
6
6
returns result
returns result
initiate
initiate
6
6
returns result
returns result
initiate
initiate
9
9
returns result
returns result
publish release
publish release
11
11
await for Prow jobs status job
await for Prow jobs...
bump security
 scanner config job
bump security...
validate release job
validate release jobText is not SVG - cannot display \ No newline at end of file diff --git a/docs/contributor/03-10-release.md b/docs/contributor/03-10-release.md index 5107ef386..1d7a52103 100644 --- a/docs/contributor/03-10-release.md +++ b/docs/contributor/03-10-release.md @@ -10,7 +10,7 @@ The BTP Manager release pipeline creates proper artifacts: ### Create a Release -![Release diagram](../assets/release.svg) +![Release diagram](../assets/release.drawio.svg) To create a release, follow these steps: @@ -25,13 +25,12 @@ To create a release, follow these steps: 2. The GitHub action, defined in the [`create-release`](/.github/workflows/create-release.yaml) file, validates the release by checking if the GitHub tag already exists, if there are any old Docker images for that GitHub tag, and if merged PRs that are part of this release are labeled correctly. Additionally, it stops the release process if a feature has been added, but only the patch version number has been bumped up. 3. If you chose in step 1.vi to bump the security scanner config, the GitHub action creates a PR with a new security scanner config that includes the new GitHub tag version. 4. A code owner approves the PR. -5. The GitHub action creates a GitHub tag and draft release with the provided name; then, it creates release assets and uploads them. -6. The GitHub action asynchronously initiates unit tests and an await for Prow jobs status. -7. The tag creation triggers the `post-btp-manager-build` Prow job, defined in [`btp-manager-build.yaml`](https://github.com/kyma-project/test-infra/blob/main/prow/jobs/kyma-project/btp-manager/btp-manager-build.yaml). -8. `post-btp-manager-build` builds a Docker image tagged with the release name. -9. The GitHub action asynchronously initiates stress tests jobs and E2E tests jobs upon Prow job success status. E2E upgrade tests run only with real credentials for Service Manager. -10. The GitHub action runs E2E tests in parallel on the k3s clusters for the most recent k3s versions and with the specified credentials. The number of the most recent k3s versions to be used is defined in the **vars.LAST_K3S_VERSIONS** GitHub variable. -11. If the unit tests, stress tests, and E2E tests are completed successfully and you have chosen to publish in step 1.vii, the GitHub action publishes the release. +5. The GitHub action creates a GitHub tag and draft release with the provided name. +6. The GitHub action asynchronously initiates unit tests and the image builders. +7. The Image builders upload the binary images. +8. The GitHub action asynchronously initiates stress tests jobs and E2E tests jobs upon Prow job success status. E2E upgrade tests run only with real credentials for Service Manager. +9. The GitHub action runs E2E tests in parallel on the k3s clusters for the most recent k3s versions and with the specified credentials. The number of the most recent k3s versions to be used is defined in the **vars.LAST_K3S_VERSIONS** GitHub variable. +10. If the unit tests, stress tests, and E2E tests are completed successfully and you have chosen to publish in step 1.vii, the GitHub action publishes the release. ### Replace an Existing Release From a9504cc1da7ca002f37308d6c21de004271d40d2 Mon Sep 17 00:00:00 2001 From: Ksawery Zietara Date: Thu, 22 Aug 2024 13:16:11 +0200 Subject: [PATCH 2/4] Update job names --- docs/assets/release.drawio.svg | 2 +- docs/contributor/03-10-release.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/assets/release.drawio.svg b/docs/assets/release.drawio.svg index 327d00735..374809b90 100644 --- a/docs/assets/release.drawio.svg +++ b/docs/assets/release.drawio.svg @@ -1,4 +1,4 @@ -
GitHub Actions
GitHub Actions
GitHub Actions
GitHub Actions
unit tests job
unit tests job
unit tests job
unit tests job
stress tests
E2E tests jobs
stress tests...
E2E tests jobs
E2E tests jobs
GitHub repository
GitHub repository
GitHub repository
GitHub repository
image builders
image builders
image builders
image builders
Docker registry
Docker registry
Docker registry
Docker registry
Create a release
Create a release
initiate
initiate
fetch binary image, module image
fetch binary image, module image
uploads binary 
image
uploads binary...
9
9
initiate
initiate
3
3
6
6
7
7
validate release job
validate release job
bump security
 scanner config job
bump security...
initiate
initiate
2
2
returns result
returns result
returns PR to approve
returns PR to approve
initiates
initiates
1
1
approves PR
approves PR
4
4
returns result
returns result
create tag and draft release
create tag and draft release
5
5
initiate
initiate
6
6
returns result
returns result
initiate
initiate
8
8
returns result
returns result
publish release
publish release
10
10
bump security
 scanner config job
bump security...
validate release job
validate release job
returns result
returns resultText is not SVG - cannot display \ No newline at end of file +
GitHub Actions
GitHub Actions
GitHub Actions
GitHub Actions
unit tests job
unit tests job
unit tests job
unit tests job
stress tests
E2E tests jobs
stress tests...
E2E tests jobs
E2E tests jobs
GitHub repository
GitHub repository
GitHub repository
GitHub repository
Image Builder
Image Builder
Image Builder
Image Builder
Docker registry
Docker registry
Docker registry
Docker registry
Create a release
Create a release
initiate
initiate
fetch binary image, module image
fetch binary image, module image
uploads binary 
image
uploads binary...
9
9
initiate
initiate
3
3
6
6
7
7
validate release job
validate release job
bump security
 scanner config job
bump security...
initiate
initiate
2
2
returns result
returns result
returns PR to approve
returns PR to approve
initiates
initiates
1
1
approves PR
approves PR
4
4
returns result
returns result
create tag and draft release
create tag and draft release
5
5
initiate
initiate
6
6
returns result
returns result
initiate
initiate
8
8
returns result
returns result
publish release
publish release
10
10
bump security
 scanner config job
bump security...
validate release job
validate release job
returns result
returns resultText is not SVG - cannot display \ No newline at end of file diff --git a/docs/contributor/03-10-release.md b/docs/contributor/03-10-release.md index 1d7a52103..fb43e106b 100644 --- a/docs/contributor/03-10-release.md +++ b/docs/contributor/03-10-release.md @@ -26,9 +26,9 @@ To create a release, follow these steps: 3. If you chose in step 1.vi to bump the security scanner config, the GitHub action creates a PR with a new security scanner config that includes the new GitHub tag version. 4. A code owner approves the PR. 5. The GitHub action creates a GitHub tag and draft release with the provided name. -6. The GitHub action asynchronously initiates unit tests and the image builders. -7. The Image builders upload the binary images. -8. The GitHub action asynchronously initiates stress tests jobs and E2E tests jobs upon Prow job success status. E2E upgrade tests run only with real credentials for Service Manager. +6. The GitHub action asynchronously initiates unit tests and the Image Builder. +7. The Image Builder upload the binary image. +8. The GitHub action asynchronously initiates stress tests jobs and E2E tests jobs upon Image Builder job success status. E2E upgrade tests run only with real credentials for Service Manager. 9. The GitHub action runs E2E tests in parallel on the k3s clusters for the most recent k3s versions and with the specified credentials. The number of the most recent k3s versions to be used is defined in the **vars.LAST_K3S_VERSIONS** GitHub variable. 10. If the unit tests, stress tests, and E2E tests are completed successfully and you have chosen to publish in step 1.vii, the GitHub action publishes the release. From d9ae10b7b9bb27c666e0491ed17bd7efd27314ab Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Thu, 22 Aug 2024 13:26:43 +0200 Subject: [PATCH 3/4] Update docs/contributor/03-10-release.md Co-authored-by: Iwona Langer --- docs/contributor/03-10-release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor/03-10-release.md b/docs/contributor/03-10-release.md index fb43e106b..de1348f7e 100644 --- a/docs/contributor/03-10-release.md +++ b/docs/contributor/03-10-release.md @@ -26,7 +26,7 @@ To create a release, follow these steps: 3. If you chose in step 1.vi to bump the security scanner config, the GitHub action creates a PR with a new security scanner config that includes the new GitHub tag version. 4. A code owner approves the PR. 5. The GitHub action creates a GitHub tag and draft release with the provided name. -6. The GitHub action asynchronously initiates unit tests and the Image Builder. +6. The GitHub action asynchronously initiates unit tests and Image Builder. 7. The Image Builder upload the binary image. 8. The GitHub action asynchronously initiates stress tests jobs and E2E tests jobs upon Image Builder job success status. E2E upgrade tests run only with real credentials for Service Manager. 9. The GitHub action runs E2E tests in parallel on the k3s clusters for the most recent k3s versions and with the specified credentials. The number of the most recent k3s versions to be used is defined in the **vars.LAST_K3S_VERSIONS** GitHub variable. From 0c13ba1d8ec16462ea48f784ca552271c4f572b4 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Thu, 22 Aug 2024 13:26:51 +0200 Subject: [PATCH 4/4] Update docs/contributor/03-10-release.md Co-authored-by: Iwona Langer --- docs/contributor/03-10-release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor/03-10-release.md b/docs/contributor/03-10-release.md index de1348f7e..487534f6f 100644 --- a/docs/contributor/03-10-release.md +++ b/docs/contributor/03-10-release.md @@ -27,7 +27,7 @@ To create a release, follow these steps: 4. A code owner approves the PR. 5. The GitHub action creates a GitHub tag and draft release with the provided name. 6. The GitHub action asynchronously initiates unit tests and Image Builder. -7. The Image Builder upload the binary image. +7. The Image Builder uploads the binary image. 8. The GitHub action asynchronously initiates stress tests jobs and E2E tests jobs upon Image Builder job success status. E2E upgrade tests run only with real credentials for Service Manager. 9. The GitHub action runs E2E tests in parallel on the k3s clusters for the most recent k3s versions and with the specified credentials. The number of the most recent k3s versions to be used is defined in the **vars.LAST_K3S_VERSIONS** GitHub variable. 10. If the unit tests, stress tests, and E2E tests are completed successfully and you have chosen to publish in step 1.vii, the GitHub action publishes the release.