Skip to content

Commit 82f5691

Browse files
committed
Add section on automatic publishing
1 parent e86c50f commit 82f5691

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

README.rst

+25-7
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Features
2828
- Uncompromising code formatting with Black_.
2929
- pytest_ helps you write better programs.
3030
- Code coverage reporting with Codecov_.
31-
- Fully automated version management and package publishing with semantic-release_.
31+
- Fully automated version management and package publishing with semantic-release__.
3232
- Continuous checks and tests with `GitHub Actions`__.
3333
- `Keep a CHANGELOG`_.
3434
- Consistent coding with EditorConfig_.
@@ -43,9 +43,9 @@ Features
4343
.. _PyPI: https://pypi.python.org/pypi
4444
.. _Pylint: https://www.pylint.org/
4545
.. _Shields.io: https://shields.io/
46+
.. __: https://semantic-release.gitbook.io/semantic-release/
4647
.. __: https://github.com/features/actions
4748
.. _pytest: https://docs.pytest.org/
48-
.. _semantic-release: https://semantic-release.gitbook.io/semantic-release/
4949

5050
Bootstrapping a New Project
5151
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -215,14 +215,32 @@ Run tests on changes with
215215
Publishing
216216
~~~~~~~~~~
217217

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

222-
Publishing may be triggered using a `workflow_dispatch on GitHub Actions`_.
220+
Automatic
221+
^^^^^^^^^
222+
223+
New versions are released automatically with semantic-release_
224+
as long as commits follow the `Angular Commit Message Conventions`_.
225+
226+
.. _Angular Commit Message Conventions: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
227+
.. _semantic-release: https://semantic-release.gitbook.io/
228+
229+
Manual
230+
^^^^^^
231+
232+
Publish a new version by triggering a `version workflow_dispatch on GitHub Actions`_.
233+
The `version` input will be passed as the first argument to `poetry version`_.
234+
235+
This may be done on the web or using the `GitHub CLI`_ with
236+
237+
::
238+
239+
$ gh workflow run version.yml --raw-field version=<version>
223240

224241
.. _Poetry version: https://python-poetry.org/docs/cli/#version
225-
.. _workflow_dispatch on GitHub Actions: https://github.com/makenew/pypackage/actions?query=workflow%3Aversion
242+
.. _GitHub CLI: https://cli.github.com/
243+
.. _version workflow_dispatch on GitHub Actions: https://github.com/seamapi/javascript-http/actions?query=workflow%3Aversion
226244

227245
GitHub Actions
228246
--------------

0 commit comments

Comments
 (0)