Skip to content

Commit 97be118

Browse files
committed
docs: update release steps in CONTRIBUTING doc
1 parent 1a7dba0 commit 97be118

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

CONTRIBUTING.rst

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -122,21 +122,15 @@ you can run:
122122
Releasing
123123
---------
124124

125-
In order to release a new version of Taskgraph, you will need permission to the
126-
`taskcluster-taskgraph`_ project in PyPI. The following are **required** steps:
125+
In order to release a new version of Taskgraph, you will need to:
127126

128127
1. Update ``CHANGELOG.md``
129128
2. Update ``__version__`` in ``src/taskgraph/__init__.py``
130-
3. Commit, and land the above changes
131-
4. Make sure your ``git status`` is clean
132-
5. Checkout the latest public revision ``git checkout main``
133-
6. Pull latest revision ``git pull upstream main``
134-
7. Verify ``git show`` outputs the desired revision
135-
8. Remove previously packaged releases and build cache ``rm -rf build dist``
136-
9. Package the app ``python setup.py sdist bdist_wheel``
137-
10. Tag and push: ``git tag -s -m "taskgraph $version" $version && git push upstream $version``
138-
11. Upload to PyPI using `twine`_ ``twine upload dist/*`` providing your
139-
username and API token
140-
141-
.. _taskcluster-taskgraph: https://pypi.org/project/taskcluster-taskgraph/
142-
.. _twine: https://pypi.org/project/twine/
129+
3. Commit, and land the above changes with a commit message like "chore: bump <version>"
130+
4. Create a release in Github pointing to the above commit. Be sure to also
131+
create a new tag matching this version.
132+
5. Wait for the ``pypi-publish`` Github workflow and ``push-image-decision`` task to finish.
133+
6. Verify that expected version has been published to `pypi`_ and pushed to `DockerHub`_.
134+
135+
.. _pypi: https://pypi.org/project/taskcluster-taskgraph
136+
.. _DockerHub: https://hub.docker.com/r/mozillareleases/taskgraph/tags

0 commit comments

Comments
 (0)