Skip to content

Commit 9071543

Browse files
committed
Update release docs for new publish workflow, remove old publish step
1 parent 7085a8d commit 9071543

File tree

2 files changed

+13
-31
lines changed

2 files changed

+13
-31
lines changed

.github/workflows/cibuildwheel.yml

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -192,32 +192,3 @@ jobs:
192192
name: cibw-wheels-${{ runner.os }}-${{ matrix.cibw_archs }}
193193
path: ./wheelhouse/*.whl
194194
if-no-files-found: error
195-
196-
publish:
197-
if: github.repository == 'matplotlib/matplotlib' && github.event_name == 'push' && github.ref_type == 'tag'
198-
name: Upload release to PyPI
199-
needs: [build_sdist, build_wheels]
200-
runs-on: ubuntu-latest
201-
environment: release
202-
permissions:
203-
id-token: write
204-
attestations: write
205-
contents: read
206-
steps:
207-
- name: Download packages
208-
uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
209-
with:
210-
pattern: cibw-*
211-
path: dist
212-
merge-multiple: true
213-
214-
- name: Print out packages
215-
run: ls dist
216-
217-
- name: Generate artifact attestation for sdist and wheel
218-
uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a # v3.0.0
219-
with:
220-
subject-path: dist/matplotlib-*
221-
222-
- name: Publish package distributions to PyPI
223-
uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0

doc/devel/release_guide.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,12 +383,23 @@ Building binaries
383383
=================
384384

385385
We distribute macOS, Windows, and many Linux wheels as well as a source tarball via
386-
PyPI. Most builders should trigger automatically once the tag is pushed to GitHub:
386+
PyPI.
387387

388388
* Windows, macOS and manylinux wheels are built on GitHub Actions. Builds are triggered
389-
by the GitHub Action defined in :file:`.github/workflows/cibuildwheel.yml`, and wheels
389+
by the GitHub Action defined in a separate
390+
`release repository <https://github.com/matplotlib/matplotlib-release>`__, and wheels
390391
will be available as artifacts of the build. Both a source tarball and the wheels will
391392
be automatically uploaded to PyPI once all of them have been built.
393+
* To trigger the build for the ``matplotlib-release`` repository:
394+
395+
* If not already created, create a release branch for the meso version (e.g. ``v3.10.x``)
396+
* Edit the ``SOURCE_REF_TO_BUILD`` environment variable at the top of
397+
`wheels.yml <https://github.com/matplotlib/matplotlib-release/blob/main/.github/workflows/wheels.yml>`__
398+
on the release branch to point to the release tag.
399+
* Run the workflow from the release branch, with "pypi" selected for the pypi environment
400+
using the `Workflow Dispatch trigger <https://github.com/matplotlib/matplotlib-release/actions/workflows/wheels.yml>`__
401+
* This will run cibuildwheel and upload to PyPI using the Trusted Publishers GitHub Action.
402+
392403
* The auto-tick bot should open a pull request into the `conda-forge feedstock
393404
<https://github.com/conda-forge/matplotlib-feedstock>`__. Review and merge (if you
394405
have the power to).

0 commit comments

Comments
 (0)