Skip to content

Commit

Permalink
WIP fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
egparedes committed Jan 29, 2025
1 parent d49d6f0 commit 11a6ed9
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/development/tools/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,20 @@ Currently, GT4Py releases are published in PyPI (and TestPyPI) and also as commi

1. Make sure all the expected changes (new features, bug fixes, documentation changes, etc.) are already included in the `main` public branch.

2. Use **bump-my-version** to update the version number.
2. Update the [CHANGELOG.md](CHANGELOG.md) file to document the changes included in the new release. Note that this step becomes much simpler when commit messages follow the [Conventional Commits][conventional-commits] convention as encouraged in the [Pull Request and Merge Guidelines](CONTRIBUTING.md#pull-request-and-merge-guidelines) section of the contributing guidelines.

3. Commit the changes with the following message:

```bash
$ bump-my-version bump minor # or patch
$ git commit -m 'Releasing {M}.{m}.{p} version.'
```

3. Update the [CHANGELOG.md](CHANGELOG.md) file to document the changes included in the new release. Note that this step becomes much simpler when commit messages follow the [Conventional Commits][conventional-commits] convention as encouraged in the [Pull Request and Merge Guidelines](CONTRIBUTING.md#pull-request-and-merge-guidelines) section of the contributing guidelines.

4. Commit the changes with the following message:
4. Tag the previous commit with the exact `v{M}.{m}.{p}` tag to update the version number and push all the changes:

```bash
$ git commit -m 'Releasing {M}.{m}.{p} version.'
$ git tag v0.1.2 # replace by the right version tag
$ git push origin master
$ git push --tags origin
```

5. On the GitHub website go to _Releases_ and _Draft a new release_. Choose `v{M}.{m}.{p}` as tag and select a branch (usually `main`). Follow the style of the previous releases for the title (`GT4Py v{M}.{m}.{p}`) and description. Then _Publish release_.
Expand Down

0 comments on commit 11a6ed9

Please sign in to comment.