Skip to content

Commit

Permalink
mdformated RELEASE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anikaweinmann committed Apr 25, 2024
1 parent e781e29 commit 7fc64bf
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Steps when releasing:

* Run in terminal
```
ESTIMATED_VERSION=1.0.0
gh api repos/mundialis/v.example/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body
```
* Go to [new release](https://github.com/mundialis/v.example/releases/new)
* Copy the output of terminal command to the release description
* You can [compare manually](https://github.com/mundialis/v.example/compare/1.0.0...main) if all changes are included. If changes were pushed directly to main branch, they are not included.
* Check if `ESTIMATED_VERSION` increase still fits - we follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
* Fill in tag and release title with this version
* At the bottom of the release, add
- Run in terminal
```
ESTIMATED_VERSION=1.0.0
gh api repos/mundialis/v.example/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body
```
- Go to [new release](https://github.com/mundialis/v.example/releases/new)
- Copy the output of terminal command to the release description
- You can [compare manually](https://github.com/mundialis/v.example/compare/1.0.0...main) if all changes are included. If changes were pushed directly to main branch, they are not included.
- Check if `ESTIMATED_VERSION` increase still fits - we follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- Fill in tag and release title with this version
- At the bottom of the release, add
"generated with `gh api repos/mundialis/v.example/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body`" and replace `$ESTIMATED_VERSION` with the actual version.
* Make sure that the checkbox for "Set as the latest release" is checked so that this version appears on the main github repo page
* Now you can save the release
- Make sure that the checkbox for "Set as the latest release" is checked so that this version appears on the main github repo page
- Now you can save the release

0 comments on commit 7fc64bf

Please sign in to comment.