Skip to content

Commit c39bdf6

Browse files
authored
Adjustments to the release process (#11410) (#11415)
As discussed in #11408: * Improve documentation for the release process. * Fix the description for the PRs created by the `prepare release pr` workflow. * Fix pushing tag in the `deploy` workflow. (cherry picked from commit e5c81fa)
1 parent b0c4775 commit c39bdf6

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

.github/workflows/deploy.yml

+2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ jobs:
3636
timeout-minutes: 30
3737
permissions:
3838
id-token: write
39+
contents: write
3940
steps:
4041
- uses: actions/checkout@v3
42+
4143
- name: Download Package
4244
uses: actions/download-artifact@v3
4345
with:

RELEASING.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ Releasing
134134
Both automatic and manual processes described above follow the same steps from this point onward.
135135

136136
#. After all tests pass and the PR has been approved, trigger the ``deploy`` job
137-
in https://github.com/pytest-dev/pytest/actions/workflows/deploy.yml.
137+
in https://github.com/pytest-dev/pytest/actions/workflows/deploy.yml, using the ``release-MAJOR.MINOR.PATCH`` branch
138+
as source.
138139

139140
This job will require approval from ``pytest-dev/core``, after which it will publish to PyPI
140141
and tag the repository.

scripts/prepare-release-pr.py

+9-3
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,16 @@ class InvalidFeatureRelease(Exception):
3131
SLUG = "pytest-dev/pytest"
3232

3333
PR_BODY = """\
34-
Created automatically from manual trigger.
34+
Created by the [prepare release pr](https://github.com/pytest-dev/pytest/actions/workflows/prepare-release-pr.yml)
35+
workflow.
3536
36-
Once all builds pass and it has been **approved** by one or more maintainers, the build
37-
can be released by pushing a tag `{version}` to this repository.
37+
Once all builds pass and it has been **approved** by one or more maintainers,
38+
start the [deploy](https://github.com/pytest-dev/pytest/actions/workflows/deploy.yml) workflow, using these parameters:
39+
40+
* `Use workflow from`: `release-{version}`.
41+
* `Release version`: `{version}`.
42+
43+
After the `deploy` workflow has been approved by a core maintainer, the package will be uploaded to PyPI automatically.
3844
"""
3945

4046

0 commit comments

Comments
 (0)