Add release steps #202
Open
Add release steps #202
Conversation
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
varshaprasad96
force-pushed
the
add/release-notes
branch
from
5131eab
to
33c7a7c
Compare
Pull Request Test Coverage Report for Build 3261135424
💛 - Coveralls |
porridge
reviewed
Oct 17, 2022
| @@ -0,0 +1,40 @@ | |||
| This document walks through the release process for helm-operator-plugins. | |||
There was a problem hiding this comment.
Suggested change
| This document walks through the release process for helm-operator-plugins. | |
| # Release process for `helm-operator-plugins` |
| **Note** | ||
| The release PR with the above mentioned change will **fail** the `sanity` test and needs to be merged forcefully. This step is done because the packages which are to be imported in the scaffolded project and the plugin code reside in the same repository. This will ensure that after the release, the plugin will also import the updated version of library helpers. | ||
|
|
||
| 2. Create a release branch with the name vX.Y.x. Example: `git checkout -b v0.0.10`. |
There was a problem hiding this comment.
Suggested change
| 2. Create a release branch with the name vX.Y.x. Example: `git checkout -b v0.0.10`. | |
| 2. Create a release branch with the name vX.Y.Z. Example: `git checkout -b v0.0.10`. |
| 3. Tag the release commit and verify the generated tag. | ||
|
|
||
| ``` | ||
| export VER=v0.0.10 |
There was a problem hiding this comment.
Suggested change
| export VER=v0.0.10 | |
| VER=v0.0.10 |
No need to pollute the environment by exporting a variable that is only interpreted by the current shell.
There was a problem hiding this comment.
Also, if you provided this variable setting as "step 0" it would be straightforward to reference it also in the commands in following steps rather than the ugly <release-branch> placeholder which is not copy-pasteable.
|
|
||
| ``` | ||
| export VER=v0.0.10 | ||
| git tag --sign --message "helm-operator-plugin $VER" "$VER" |
There was a problem hiding this comment.
This seems to require some prior GPG setup. Might be useful to mention this as a prerequisite.
There was a problem hiding this comment.
overall looks good to me. I agree with @porridge's review suggestions/comments.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add release steps.