@@ -28,7 +28,7 @@ Features
28
28
- Uncompromising code formatting with Black _.
29
29
- pytest _ helps you write better programs.
30
30
- 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 __ .
32
32
- Continuous checks and tests with `GitHub Actions `__.
33
33
- `Keep a CHANGELOG `_.
34
34
- Consistent coding with EditorConfig _.
@@ -43,9 +43,9 @@ Features
43
43
.. _PyPI : https://pypi.python.org/pypi
44
44
.. _Pylint : https://www.pylint.org/
45
45
.. _Shields.io : https://shields.io/
46
+ .. __ : https://semantic-release.gitbook.io/semantic-release/
46
47
.. __ : https://github.com/features/actions
47
48
.. _pytest : https://docs.pytest.org/
48
- .. _semantic-release : https://semantic-release.gitbook.io/semantic-release/
49
49
50
50
Bootstrapping a New Project
51
51
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -215,14 +215,32 @@ Run tests on changes with
215
215
Publishing
216
216
~~~~~~~~~~
217
217
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 `_.
221
219
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>
223
240
224
241
.. _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
226
244
227
245
GitHub Actions
228
246
--------------
0 commit comments