Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: densify releasing doc #217

Merged
merged 1 commit into from
Jun 24, 2024
Merged

doc: densify releasing doc #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/development/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Release workflow

1. Fill the `CHANGELOG.md` with the new version
1. Fill the `CHANGELOG.md` with the new version. You can write it manually or use the auto-generated release notes by Github:
1. Go to [project's releases](https://github.com/geotribu/cli/releases) and click on `Draft a new release`
1. In `Choose a tag`, enter the new tag
1. Click on `Generate release notes`
1. Copy/paste the generated text from `## What's changed` until the line before `**Full changelog**:...` in the CHANGELOG.md replacing `What's changed` with the tag and the publication date
1. Change the version number in `__about__.py`
1. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "New awesome feature"`
1. Push tag to main branch: `git push origin --tags`
Expand Down