Skip to content

Commit fc74d22

Browse files
committed
Update Publishing section in README
1 parent 3bf968c commit fc74d22

1 file changed

Lines changed: 24 additions & 6 deletions

File tree

README.rst

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,32 @@ Run tests on changes with
106106
Publishing
107107
~~~~~~~~~~
108108

109-
Use the `poetry version`_ command to release a new version.
110-
Then run `make version` to commit and push a new git tag
111-
which will trigger a GitHub action.
109+
New versions are created with `poetry version`_.
112110

113-
Publishing may be triggered using a `workflow_dispatch on GitHub Actions`_.
111+
Automatic
112+
^^^^^^^^^
113+
114+
New versions are released automatically with semantic-release_
115+
as long as commits follow the `Angular Commit Message Conventions`_.
116+
117+
.. _Angular Commit Message Conventions: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
118+
.. _semantic-release: https://semantic-release.gitbook.io/
119+
120+
Manual
121+
^^^^^^
122+
123+
Publish a new version by triggering a `version workflow_dispatch on GitHub Actions`_.
124+
The `version` input will be passed as the first argument to `poetry version`_.
125+
126+
This may be done on the web or using the `GitHub CLI`_ with
127+
128+
::
129+
130+
$ gh workflow run version.yml --raw-field version=<version>
114131

115132
.. _Poetry version: https://python-poetry.org/docs/cli/#version
116-
.. _workflow_dispatch on GitHub Actions: https://github.com/seamapi/python-next/actions?query=workflow%3Aversion
133+
.. _GitHub CLI: https://cli.github.com/
134+
.. _version workflow_dispatch on GitHub Actions: https://github.com/seamapi/python-next/actions?query=workflow%3Aversion
117135

118136
GitHub Actions
119137
--------------
@@ -129,7 +147,7 @@ These must be set manually.
129147
Secrets for Optional GitHub Actions
130148
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131149

132-
The version and format GitHub actions
150+
The version, format, generate, and semantic-release GitHub actions
133151
require a user with write access to the repository
134152
including access to read and write packages.
135153
Set these additional secrets to enable the action:

0 commit comments

Comments
 (0)