|
9 | 9 | This document outlines the steps to perform a release.
|
10 | 10 |
|
11 | 11 | ### Determine if a Release is Required
|
| 12 | +- Make sure to have GitPython python package installed |
12 | 13 | - Run the release checker script:
|
13 | 14 | ```
|
14 | 15 | python3 .ci/scripts/check_release.py
|
15 | 16 | ```
|
16 | 17 |
|
17 |
| -### Create a New Y-branch (e.g., 3.23) |
18 |
| -- If a new minor version (Y) is needed, trigger a [Create New Release Branch](https://github.com/pulp/pulp_python/actions/workflows/create-branch.yml) job via the GitHub Actions. |
| 18 | +### Release a New Y-version (e.g., 3.23.0) |
| 19 | +- If a new minor version (Y) is needed, trigger a [Create New Release Branch](https://github.com/pulp/pulp_python/actions/workflows/create-branch.yml) job from the main branch via the GitHub Actions. |
19 | 20 | - Look for the "Bump minor version" pull request and merge it.
|
| 21 | +- Trigger a [Release Pipeline](https://github.com/pulp/pulp_python/actions/workflows/release.yml) job by specifying the new release branch (X.**Y**) via the GitHub Actions. |
20 | 22 |
|
21 | 23 | ### Release a New Z-version (Patch Release) (e.g., 3.23.1, 3.22.12)
|
22 | 24 | - Trigger a [Release Pipeline](https://github.com/pulp/pulp_python/actions/workflows/release.yml) job by specifying the release branch (X.Y) via the GitHub Actions.
|
23 | 25 |
|
24 |
| -### Final Steps (Optional but Recommended) |
25 |
| -- Ensure the new version appears on PyPI. |
26 |
| -- Verify that the changelog has been updated by looking for the "Update Changelog" pull request. |
27 |
| -- Post a brief announcement about the new release on the [Pulp Discourse](https://discourse.pulpproject.org/). |
| 26 | +## Final Steps |
| 27 | +- Ensure the new version appears on PyPI (it should appear after [Publish Release](https://github.com/pulp/pulp_python/actions/workflows/publish.yml) workflow succeeds). |
| 28 | +- Verify that the changelog has been updated by looking for the "Update Changelog" pull request (A new PR should be available on the next day). |
| 29 | +- [optional] Post a brief announcement about the new release on the [Pulp Discourse](https://discourse.pulpproject.org/). |
0 commit comments