Skip to content

Commit 1c151f0

Browse files
authored
Minor updates in release notes (#397)
* Minor updates in release notes * fix linter * fix linter
1 parent 338efcc commit 1c151f0

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,30 +92,28 @@ The repo uses GitHub workflows to publish a draft release when a new tag is
9292
pushed. We use [semver](https://semver.org/#summary) to determine the version
9393
number vor the tag.
9494
95-
*Before pushing a tag*, the pyproject version needs to be bumped.
96-
9795
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).
9896
* Review the tags on each PR and make sure they are categorized
9997
appropriately.
10098
10199
1. Run `BUMP=(bugfix|feature|breaking) make bump_version` to update the `pydo`
102-
version.
103-
* `BUMP` also accepts `(patch|minor|major)`
100+
version.
101+
`BUMP` also accepts `(patch|minor|major)`
102+
103+
Command example:
104104
105-
Command example:
105+
```bash
106+
make BUMP=minor bump_version
107+
```
106108
107-
```code
108-
make BUMP=minor bump_version
109-
```
109+
1. Update the Pydo version in `pyproject.toml` and `src/pydo/_version.py`. Create a separate PR with only these changes.
110110
111-
1. Run `make generate` to update the version in the codebase. Make a pull request with this change.
112-
It should be separate from PRs containing changes to the library (including regenerated code).
113-
1. Once the version bump PR has been pushed and merged, tag the commit to trigger the
111+
1. Once the PR has been pushed and merged, tag the commit to trigger the
114112
release workflow: run `make tag` to tag the latest commit and push the tag to ORIGIN.
115113
116114
Notes:
117115
* To tag an earlier commit, run `COMMIT=${commit} make tag`.
118116
* To push the tag to a different remote, run `ORIGIN=${REMOTE} make tag`.
119-
1. Once the release process completes, review the draft release for correctness and publish the release.
120117
121-
Ensure the release has been marked `Latest`.
118+
1. Once the release process completes, review the draft release for correctness and publish the release.
119+
Ensure the release has been marked `Latest`.

0 commit comments

Comments
 (0)