-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a647bc1
commit d6864b1
Showing
47 changed files
with
125 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -177,21 +177,21 @@ Promoting the images basically means that images, that were pushed to staging co | |
``` | ||
- The -L 38 was used for 2 reasons. | ||
- Default number of results is 30 and there were more than 30 PRs merged while releasing v1.1.1. If you see the current/soon-to-be-old changelog, you can look at the most recent PR number that has been accounted for already, and start from after that last accounted for PR. | ||
- The other reason to use -L 38 was to ommit the 39th, the 40th and the 41st line in the resulting list. These were non-relevant PRs. | ||
- The other reason to use -L 38 was to omit the 39th, the 40th and the 41st line in the resulting list. These were non-relevant PRs. | ||
- If you save the output of above command to a file called prlist.txt. It looks somewhat like this ; | ||
|
||
``` | ||
% cat ~/Downloads/prlist.txt | ||
% cat ~/Downloads/prlist.txt | ||
8129 fix syntax in docs for multi-tls example | ||
8120 Update go in runner and release v1.1.1 | ||
8119 Update to go v1.17.6 | ||
8118 Remove deprecated libraries, update other libs | ||
8117 Fix codegen errors | ||
8115 chart/ghaction: set the correct permission to have access to push a release | ||
8115 chart/ghaction: set the correct permission to have access to push a release | ||
.... | ||
``` | ||
You can delete the lines, that refer to PRs of the release process itself. We only need to list the feature/bugfix PRs. You can also delete the lines that are housekeeping or not really worth mentioning in the changelog. | ||
- you use some easy automation in bash/python/other, to get the PR-List that can be used in the changelog. For example, its possible to use a bash scripty way, seen below, to convert those plaintext PR numbers into clickable links. | ||
- you use some easy automation in bash/python/other, to get the PR-List that can be used in the changelog. For example, it's possible to use a bash scripty way, seen below, to convert those plaintext PR numbers into clickable links. | ||
|
||
``` | ||
#!/usr/bin/bash | ||
|
@@ -205,7 +205,7 @@ Promoting the images basically means that images, that were pushed to staging co | |
done <$file | ||
``` | ||
- There was a parsing issue and path issue on MacOS, so above scrpt had to be modified and MacOS monterey compatible script is below ; | ||
- There was a parsing issue and path issue on MacOS, so above script had to be modified and MacOS monterey compatible script is below ; | ||
|
||
``` | ||
#!/bin/bash | ||
|
@@ -231,7 +231,7 @@ Promoting the images basically means that images, that were pushed to staging co | |
- tag | ||
- digest | ||
|
||
- [helm-docs](https://github.com/norwoodj/helm-docs) is a tool that generates the README.md for a helm-chart automatically. In the CI pipeline workflow of github actions (/.github/workflows/ci.yaml), you can see how helm-docs is used. But the CI pipeline is not designed to make commits back into the project. So we need to run helm-docs manually, and check in the resulting autogenerated README.md at the path /charts/ingress-nginx/README.md | ||
- [helm-docs](https://github.com/norwoodj/helm-docs) is a tool that generates the README.md for a helm-chart automatically. In the CI pipeline workflow of github actions (/.github/workflows/ci.yaml), you can see how helm-docs is used. But the CI pipeline is not designed to make commits back into the project. So we need to run helm-docs manually, and check in the resulting autogenerated README.md at the path /charts/ingress-nginx/README.md | ||
``` | ||
GOBIN=$PWD GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/[email protected] | ||
./helm-docs --chart-search-root=${GITHUB_WORKSPACE}/charts | ||
|
@@ -274,7 +274,7 @@ Promoting the images basically means that images, that were pushed to staging co | |
|
||
### h. Update README.md | ||
|
||
- Update the table in README.md in the root of the projet to reflect the support matrix. Add the new release version and details in there. | ||
- Update the table in README.md in the root of the project to reflect the support matrix. Add the new release version and details in there. | ||
|
||
## 5. RELEASE new version | ||
|
||
|
@@ -291,7 +291,7 @@ Promoting the images basically means that images, that were pushed to staging co | |
- `helm repo update` | ||
- `helm search repo ingress-nginx` | ||
|
||
## 6. Github release | ||
## 6. GitHub release | ||
|
||
- Release to github | ||
|
||
|
Oops, something went wrong.