@@ -92,30 +92,28 @@ The repo uses GitHub workflows to publish a draft release when a new tag is
92
92
pushed. We use [semver](https://semver.org/#summary) to determine the version
93
93
number vor the tag.
94
94
95
- *Before pushing a tag*, the pyproject version needs to be bumped.
96
-
97
95
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).
98
96
* Review the tags on each PR and make sure they are categorized
99
97
appropriately.
100
98
101
99
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:
104
104
105
- Command example:
105
+ ```bash
106
+ make BUMP=minor bump_version
107
+ ```
106
108
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.
110
110
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
114
112
release workflow: run `make tag` to tag the latest commit and push the tag to ORIGIN.
115
113
116
114
Notes:
117
115
* To tag an earlier commit, run `COMMIT=${commit} make tag`.
118
116
* 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.
120
117
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