-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(release): Remove confluence changelog from RELEASE.md. Adapt desc…
…ription of changelog creation. (#697) Task: IL-413 Co-authored-by: Sebastian Niehus <[email protected]>
- Loading branch information
1 parent
0d5e77a
commit 50317ec
Showing
1 changed file
with
1 addition
and
6 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 |
---|---|---|
@@ -1,16 +1,11 @@ | ||
# Release cycle TODOs | ||
|
||
- Prepare the changelog in some MD file | ||
- **Ideally** the merge request messages should be in a format that allows you to just copy them into the changelog. | ||
- Present the changelog in the daily. | ||
- Update CHANGELOG.md | ||
- Use the prepared changelog and adjust based on feedback from the daily and new changes to the main branch since then. | ||
- We committed to updating the changelog with every relevant merge into main. Check the new entries of the changelog and perform adjustments where necessary. | ||
- Update the "version" field of the project in `pyproject.toml` | ||
- We use [semantic versioning](https://semver.org/) | ||
- Commit the changes and merge to main | ||
- Create a new release tag in GitHub (Tags -> Releases -> Draft a new release) and save it as draft | ||
- Copy the changelog into the release description. Also add a link to the commits since the last release at the bottom of the description. | ||
- Update changelog at https://aleph-alpha.atlassian.net/wiki/spaces/EN/pages/632520766/Changelogs. | ||
- Best just copy over the changes from CHANGELOG.md and adjust the formatting. | ||
- Make sure the changes have been merged into the main branch. | ||
- Publish the release. |