Skip to content

Commit 77f98f1

Browse files
committed
Clarify release instructions
1 parent 59fc4a6 commit 77f98f1

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/contributing.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,19 @@ testing and supporting, the following files must be considered:
7878
Releases
7979
--------
8080

81-
1. Make sure that ``a3m.__version__`` reflects the new version.
82-
2. Make sure that the changelog has been updated.
83-
Use ``scriv collect`` to populate ``CHANGELOG.rst``, submit the changes.
84-
3. Create and push git tag, e.g.::
81+
We aim to further enhance and automate our release process.
8582

86-
$ git tag v0.7.1
87-
$ git push origin refs/tags/v0.7.1
83+
Please adhere to the following instructions:
84+
85+
1. Update the ``main`` branch with the latest version (``a3m.__version__``) and
86+
the changelog (use ``scriv collect`` to populate ``CHANGELOG.rst``). Submit
87+
these changes through a pull request and merge it once all checks have
88+
passed.
89+
2. Confirm that the checks are also passing in ``main``.
90+
3. Create and push the git tag, e.g.::
91+
92+
$ git tag v0.7.7
93+
$ git push origin refs/tags/v0.7.7
8894

8995
This should have triggered the publishing workflow. Confirm that the new
9096
version of the package is in `PyPI <https://pypi.org/project/a3m/>`_.
@@ -93,9 +99,9 @@ Releases
9399

94100
$ docker build \
95101
-t ghcr.io/artefactual-labs/a3m:latest \
96-
-t ghcr.io/artefactual-labs/a3m:v0.7.1 \
102+
-t ghcr.io/artefactual-labs/a3m:v0.7.7 \
97103
.
98104
5. Push Docker image to the registry::
99105

100106
$ docker push ghcr.io/artefactual-labs/a3m:latest
101-
$ docker push ghcr.io/artefactual-labs/a3m:v0.7.2
107+
$ docker push ghcr.io/artefactual-labs/a3m:v0.7.7

0 commit comments

Comments
 (0)