Skip to content

Commit

Permalink
Update release docs with drafts explanation
Browse files Browse the repository at this point in the history
Signed-off-by: Marco Franssen <marco.franssen@philips.com>
  • Loading branch information
marcofranssen committed Jan 14, 2022
1 parent 91e5591 commit 598f792
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion release.md → RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
To make a new release you can make use of the following `make` task.

```bash
make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.1-draft DESCRIPTION="A test release to see how it works"
make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.0 DESCRIPTION="A test release to see how it works"
```

`NEW_VERSION` the version that you want to release.
Expand All @@ -15,6 +15,8 @@ make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.1-draft DESCRIPTION="A test
Visit <https://github.com/philips-labs/slsa-provenance-action/releases>.
Edit the release and save it to publish to GitHub Marketplace.

> :warning: **NOTE:** when you need to test some changes in `.goreleaser.yml`, also apply the changes to `.goreleaser.draft.yml`. Then make sure your new `tag` ends with `-draft` (e.g.: `v0.7.0-draft`) to make a draft release to not notify our consumers when testing updates to the release process.
### ⚠ Important alert for MacOS users ⚠

On MacOS `sed` has different behaviour and therefore doesn't work out of the box.
Expand Down

0 comments on commit 598f792

Please sign in to comment.