Adjustments to the release process (#11410)

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.
This commit is contained in:
Bruno Oliveira 2023-09-08 07:22:16 -03:00 committed by GitHub
parent 0a06db0729
commit e5c81fa41a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 4 deletions

View File

@ -36,8 +36,10 @@ jobs:
timeout-minutes: 30 timeout-minutes: 30
permissions: permissions:
id-token: write id-token: write
contents: write
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: Download Package - name: Download Package
uses: actions/download-artifact@v3 uses: actions/download-artifact@v3
with: with:

View File

@ -134,7 +134,8 @@ Releasing
Both automatic and manual processes described above follow the same steps from this point onward. Both automatic and manual processes described above follow the same steps from this point onward.
#. After all tests pass and the PR has been approved, trigger the ``deploy`` job #. After all tests pass and the PR has been approved, trigger the ``deploy`` job
in https://github.com/pytest-dev/pytest/actions/workflows/deploy.yml. in https://github.com/pytest-dev/pytest/actions/workflows/deploy.yml, using the ``release-MAJOR.MINOR.PATCH`` branch
as source.
This job will require approval from ``pytest-dev/core``, after which it will publish to PyPI This job will require approval from ``pytest-dev/core``, after which it will publish to PyPI
and tag the repository. and tag the repository.

View File

@ -31,10 +31,16 @@ class InvalidFeatureRelease(Exception):
SLUG = "pytest-dev/pytest" SLUG = "pytest-dev/pytest"
PR_BODY = """\ PR_BODY = """\
Created automatically from manual trigger. Created by the [prepare release pr](https://github.com/pytest-dev/pytest/actions/workflows/prepare-release-pr.yml)
workflow.
Once all builds pass and it has been **approved** by one or more maintainers, the build Once all builds pass and it has been **approved** by one or more maintainers,
can be released by pushing a tag `{version}` to this repository. start the [deploy](https://github.com/pytest-dev/pytest/actions/workflows/deploy.yml) workflow, using these parameters:
* `Use workflow from`: `release-{version}`.
* `Release version`: `{version}`.
After the `deploy` workflow has been approved by a core maintainer, the package will be uploaded to PyPI automatically.
""" """