Skip to content

Commit f1d4da2

Browse files
MatthewMiddlehurstchrisholder
authored andcommitted
[MNT] Updated the release workflows (#2638)
* edit release workflows to use trusted publishing * docs
1 parent 7240e98 commit f1d4da2

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

.github/workflows/fast_release.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ jobs:
3030
upload-wheels:
3131
runs-on: ubuntu-24.04
3232

33+
environment:
34+
name: release
35+
url: https://pypi.org/p/aeon/
36+
permissions:
37+
id-token: write
38+
3339
steps:
3440
- uses: actions/download-artifact@v4
3541
with:
@@ -38,5 +44,3 @@ jobs:
3844

3945
- name: Publish package to PyPI
4046
uses: pypa/gh-action-pypi-publish@release/v1
41-
with:
42-
password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/release.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@ jobs:
101101
needs: test-wheels
102102
runs-on: ubuntu-24.04
103103

104+
environment:
105+
name: release
106+
url: https://pypi.org/p/aeon/
107+
permissions:
108+
id-token: write
109+
104110
steps:
105111
- uses: actions/download-artifact@v4
106112
with:
@@ -109,5 +115,3 @@ jobs:
109115

110116
- name: Publish package to PyPI
111117
uses: pypa/gh-action-pypi-publish@release/v1
112-
with:
113-
password: ${{ secrets.PYPI_TOKEN }}

docs/developer_guide/release.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,19 @@ The release process is as follows, on high-level:
4141

4242
Creation of the GitHub release trigger the `pypi` release workflow.
4343

44-
5. **Wait for the ``pypi`` release CI/CD to finish.**
44+
5. **Approve the release workflow.**
45+
The release workflow will be automatically created in the GitHub Actions tab. This
46+
must be approved by a member of the release management workgroup before it will run.
47+
48+
6. **Wait for the ``pypi`` release CI/CD to finish.**
4549
If tests fail due to sporadic unrelated failure, restart. If tests fail genuinely,
4650
something went wrong in the above steps, investigate, fix, and repeat. If the bug
4751
is known and sporadic (i.e. failure to read data from an external source), the release
4852
workflow can be restarted. It is not necessary to create a new GitHub release, and
4953
the workflow can be manually run from the GitHub Actions tab if more PRs are
5054
required.
5155

52-
6. **Release workflow completion tasks.**
56+
7. **Release workflow completion tasks.**
5357
Once the release workflow has passed, check `aeon` version on `pypi`, this should be
5458
the new version. A validatory installation of `aeon` in a new Python environment
5559
should be carried out according to the installation instructions. If the installation
@@ -58,7 +62,7 @@ Creation of the GitHub release trigger the `pypi` release workflow.
5862

5963
## `conda-forge` release and release validation
6064

61-
7. **Merge the ``conda-forge`` release PR.**
65+
8. **Merge the ``conda-forge`` release PR.**
6266
After some time a PR will be automatically created in the [aeon conda-forge feedstock](https://github.com/conda-forge/aeon-feedstock).
6367
Follow the instructions in the PR to merge it, making sure to update any dependencies
6468
that have changed and dependency version bounds.

0 commit comments

Comments
 (0)