This repository has been archived by the owner on May 30, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
122 additions
and
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
exclude-tags=rolling | ||
base=CHANGELOG.md | ||
user=trento-project | ||
project=trento | ||
usernames-as-github-logins=true | ||
configure-sections={"added":{"prefix":"### Added","labels":["addition","enhancement"]},"fixed":{"prefix":"### Fixed","labels":["bug","fix"]},"removed":{"prefix":"### Removed","labels":["removal"]}} | ||
pr-label=### Other Changes | ||
issues-wo-labels=false |
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 |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# How to release a new version of Trento | ||
|
||
> Note: this document is a draft! | ||
## Pre-requisites | ||
|
||
Install [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) globally in your dev box: | ||
``` | ||
gem install github_changelog_generator | ||
``` | ||
|
||
## Update the changelog and create a new tag | ||
|
||
```bash | ||
# always create a dedicated release branch | ||
git switch -c release-x.y.z | ||
|
||
# x1.y1.z1 is the previous release tag | ||
github_changelog_generator --since-tag=x1.y1.z1 --future-release=x.y.z | ||
|
||
git add CHANGELOG.md | ||
git commit -m "add x.y.z changelog entry" | ||
|
||
# maybe make some other last minute changes | ||
# [...] | ||
|
||
# merge and tag, making sure the tag is on the merge commit | ||
git switch main | ||
git merge --no-ff release-x.y.z | ||
git tag x.y.z | ||
|
||
# don't forget to force update the rolling tag! | ||
git fetch --tags -f | ||
|
||
# push directly | ||
git push --tags origin main | ||
``` | ||
|
||
Optionally, open a pull request from the release branch instead of tagging and pushing manually. | ||
|
||
## GitHub release | ||
|
||
> Note: this step will soon be automated. | ||
Go to the [project releases page](https://github.com/trento-project/trento/releases) and create a new release, then: | ||
|
||
- use the just created git tag as the release tag and title; | ||
- copy-paste the last changelog entry from `CHANGELOG.md` as the release body; | ||
- hit the green button; | ||
- profit! |
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