Skip to content

Commit c5f24dd

Browse files
authored
docs: Tell how to use GitHub to find commits in an upcoming release. (#1092)
I can never remember what the syntax is of the compare URLs, so just doc it to make it easier.
1 parent 73aec8f commit c5f24dd

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

DEVELOPING.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,24 @@ Start from a clean checkout at `main`.
77
Before running through the release it's good to run the build and the tests locally, and make sure CI is passing. You can
88
also test-drive the commit in an existing Bazel workspace to sanity check functionality.
99

10+
#### Steps
11+
1. [Determine the next semantic version number](#determining-semantic-version)
12+
1. Create a tag and push, e.g. `git tag 0.5.0 upstream/main && git push upstream --tags`
13+
NOTE: Pushing the tag will trigger release automation.
14+
1. Watch the release automation run on https://github.com/bazelbuild/rules_python/actions
15+
1. Add missing information to the release notes. The automatic release note
16+
generation only includes commits associated with issues.
17+
1018
#### Determining Semantic Version
1119

1220
**rules_python** is currently using [Zero-based versioning](https://0ver.org/) and thus backwards-incompatible API
1321
changes still come under the minor-version digit. So releases with API changes and new features bump the minor, and
14-
those with only bug fixes and other minor changes bump the patch digit.
22+
those with only bug fixes and other minor changes bump the patch digit.
23+
24+
To find if there were any features added or incompatible changes made, review
25+
the commit history. This can be done using github by going to the url:
26+
`https://github.com/bazelbuild/rules_python/compare/<VERSION>...main`.
1527

16-
#### Steps
17-
1. Determine what will be the next release, following semver.
18-
1. Create a tag and push, e.g. `git tag 0.5.0 upstream/main && git push upstream --tags`
19-
1. Watch the release automation run on https://github.com/bazelbuild/rules_python/actions
20-
2128
#### After release creation in Github
2229

2330
1. Ping @philwo to get the new release added to mirror.bazel.build. See [this comment on issue #400](https://github.com/bazelbuild/rules_python/issues/400#issuecomment-779159530) for more context.

0 commit comments

Comments
 (0)