Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use separate Github environment for releasing pytest-taskgraph #614

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Use separate Github environment for releasing pytest-taskgraph #614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb6025c
ci(pytest-taskgraph): use separate Github environment for release
ahal Dec 12, 2024
8234e35
docs(pytest-taskgraph): improve release documentation
ahal Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pypi-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
name: upload release to PyPI
if: startsWith(github.ref, 'refs/tags/pytest-taskgraph')
runs-on: ubuntu-latest
environment: release
environment: pytest-taskgraph-release
permissions:
id-token: write
steps:
Expand Down
18 changes: 13 additions & 5 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,12 @@ In order to release a new version of Taskgraph, you will need to:
1. Update ``CHANGELOG.md``
2. Update ``__version__`` in ``src/taskgraph/__init__.py``
3. Commit, and land the above changes with a commit message like "chore: bump <version>"
4. Create a release in Github pointing to the above commit. Be sure to also
create a new tag matching this version.
4. Draft a release in Github pointing to the above commit.

a. Create a new tag of the form ``X.Y.Z``
b. Ensure "Set as latest release" is checked
c. Submit the release

5. Wait for the ``pypi-publish`` Github workflow and ``push-image-decision`` task to finish.
6. Verify that expected version has been published to `pypi
<https://pypi.org/project/taskcluster-taskgraph>`__ and pushed to `DockerHub`_.
Expand All @@ -174,9 +178,13 @@ release process for this package is:

1. Update ``version`` in ``packages/pytest-taskgraph/pyproject.toml``
2. Commit and land the changes with a commit message like "chore: bump pytest-taskgraph <version>"
3. Create a release in Github pointing to the above commit. Be sure to also
create a new tag of the form ``pytest-taskgraph-v<version>``.
4. Wait for the ``pypi-publish`` Github workflow and ``push-image-decision`` task to finish.
3. Draft a release in Github pointing to the above commit.

a. Create a new tag of the form ``pytest-taskgraph-vX.Y.Z``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bit weird to have vX.Y.Z on this tag but not on the other. Don't have a very strong opinion on this though

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah... I kind of wish we had used vX.Y.Z for the other one, it would make some Taskgraph logic easier and seems to be more of a standard. I don't mind dropping the v here though, also not a super strong opinion.

b. Uncheck "Set as latest release"
c. Submit the release

4. Wait for the ``pypi-publish`` Github workflow to finish.
5. Verify that expected version has been published to `pypi <https://pypi.org/project/pytest-taskgraph>`__.


Expand Down
Loading