Skip to content

Commit

Permalink
Minor updates in release notes (#397)
Browse files Browse the repository at this point in the history
* Minor updates in release notes

* fix linter

* fix linter
  • Loading branch information
loosla authored Dec 20, 2024
1 parent 338efcc commit 1c151f0
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,30 +92,28 @@ The repo uses GitHub workflows to publish a draft release when a new tag is
pushed. We use [semver](https://semver.org/#summary) to determine the version
number vor the tag.
*Before pushing a tag*, the pyproject version needs to be bumped.
1. Run `make changes` to review the merged PRs since last release and decide what kind of release you are doing (bugfix, feature or breaking).
* Review the tags on each PR and make sure they are categorized
appropriately.
1. Run `BUMP=(bugfix|feature|breaking) make bump_version` to update the `pydo`
version.
* `BUMP` also accepts `(patch|minor|major)`
version.
`BUMP` also accepts `(patch|minor|major)`
Command example:
Command example:
```bash
make BUMP=minor bump_version
```
```code
make BUMP=minor bump_version
```
1. Update the Pydo version in `pyproject.toml` and `src/pydo/_version.py`. Create a separate PR with only these changes.
1. Run `make generate` to update the version in the codebase. Make a pull request with this change.
It should be separate from PRs containing changes to the library (including regenerated code).
1. Once the version bump PR has been pushed and merged, tag the commit to trigger the
1. Once the PR has been pushed and merged, tag the commit to trigger the
release workflow: run `make tag` to tag the latest commit and push the tag to ORIGIN.
Notes:
* To tag an earlier commit, run `COMMIT=${commit} make tag`.
* To push the tag to a different remote, run `ORIGIN=${REMOTE} make tag`.
1. Once the release process completes, review the draft release for correctness and publish the release.
Ensure the release has been marked `Latest`.
1. Once the release process completes, review the draft release for correctness and publish the release.
Ensure the release has been marked `Latest`.

0 comments on commit 1c151f0

Please sign in to comment.