-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add make command to automate release procedure
Co-authored-by: Marco Franssen <marco.franssen@philips.com> Signed-off-by: Brend Smits <brend.smits@philips.com>
- Loading branch information
1 parent
33cb940
commit 60854d2
Showing
2 changed files
with
27 additions
and
4 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,20 @@ | ||
# Release | ||
# Automated release procedure | ||
|
||
A make script has been created to automate the manual procedure. | ||
Execute the following command: | ||
```bash | ||
make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.0 DESCRIPTION="A test release to see how it works" | ||
``` | ||
|
||
`NEW_VERSION` is the version that you want to release. | ||
`OLD_VERSION` is the previous version you wish to overwrite in the markdown and yaml files. | ||
`DESCRIPTION` is the description to use in the annotation of the tag and commit description. | ||
|
||
# Manual release procedure | ||
|
||
1. Upgrade version number in all repository files, find & replace previous version number with new version number. | ||
1. Commit the changed files. | ||
1. Tag the new commit using `git tag -sam "What is this release about?" v0.1.0`. | ||
|
||
## Experimental | ||
|
||
1. Push the tag to remote using `git push v0.1.0` | ||
1. Wait for the release workflow to finish, then push the main branch using `git push` | ||
|