-
Notifications
You must be signed in to change notification settings - Fork 278
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: added release process #827
Merged
jannfis
merged 2 commits into
argoproj-labs:master
from
kostis-codefresh:release-process
Aug 14, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Releasing | ||
|
||
Argo Image Updater is released in a 2 step automated fashion using GitHub actions. The release process takes about 20 minutes, sometimes a little less, depending on the performance of GitHub Actions runners. | ||
|
||
Releases can only be done by people that have write/commit access on the Argo Image Updater GitHub repository. | ||
|
||
## Introduction | ||
|
||
First install on your workstation the following: | ||
|
||
1. GoLang | ||
1. The `git` executable | ||
1. The [GitHub CLI](https://cli.github.com/) | ||
1. The `semver` cli with `go install github.com/davidrjonas/semver-cli@latest` | ||
|
||
Then create a release branch: | ||
|
||
``` | ||
git clone [email protected]:argoproj-labs/argocd-image-updater.git | ||
git branch -b release-0.13 | ||
git push origin release-0.13 | ||
``` | ||
|
||
The release name is just an example. You should use the next number from the [previous release](https://github.com/argoproj-labs/argocd-image-updater/releases). Make sure that the branch is named as `release-X.XX` though. | ||
|
||
Also note that `origin` is just an example. It should be the name of your remote that holds the upstream branch of Argo Image updater. | ||
|
||
Finally run | ||
|
||
``` | ||
./hack/create-release-pr.sh origin | ||
``` | ||
|
||
Again notice that the argument must match the upstream Git remote that you used before. This [command](https://github.com/argoproj-labs/argocd-image-updater/blob/master/hack/create-release-pr.sh) will automatically create a Pull Request in GitHub with the contents of the new release. | ||
|
||
## Review the pull request | ||
|
||
Visit the Pull Request that you just created in the GitHub UI. Validate the contents of the diff to see the suggested changes. | ||
Once you are happy with the result, approve/merge the Pull Request. | ||
|
||
Merging the Pull Request will start an [automated release process](https://github.com/argoproj-labs/argocd-image-updater/blob/master/.github/workflows/create-release-draft.yaml) that will build all the artifacts | ||
and create a draft release. | ||
|
||
## Publish the release | ||
|
||
You should now have a draft release or Argo Image Updater with all required artifacts attached as binaries. | ||
|
||
First, attach the release notes. [GitHub can do it automatically for you](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) by clicking the respective button | ||
and selecting from the drop-down menu the previous release. | ||
|
||
Finally publish the release by clicking the green button on the bottom left of the screen. | ||
|
||
You are finished! | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be noted that this script needs the GitHub CLI. It also uses something called
semver-cli
, which I've never heard of.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the requirements in the documentation page itself.