Skip to content

Commit

Permalink
update(docs): add how to use autogenerated release notes from GitHub (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts authored Sep 5, 2024
2 parents 6e4ac79 + a289178 commit 4fad74e
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions docs/development/releasing.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
# Release workflow

1. Fill the `CHANGELOG.md`
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/Guts/qgis-deployment-cli/releases) and click on `Draft a new release`
1. In `Choose a tag`, enter the new tag (obviously complying with [SemVer](https://semver.org/))
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. Commit changes with a message like `Bump version to X.x.x` to the main branch
1. Commit changes with a message like `release: bump version to X.x.x` to the main branch
1. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "New awesome feature"`
1. Push commit and tag to main branch: `git push --tags`

If things go wrong (failed CI/CD pipeline, missed step...), here comes the fix process:

```sh
git tag -d old
git push origin :refs/tags/old
git push --tags
```

And try again!

----

## Manual upload to PyPi

> This method requires an API token on PyPi
Expand Down

0 comments on commit 4fad74e

Please sign in to comment.