Skip to content

Commit bd235da

Browse files
hf-kkleinOLILHR
andauthored
docs: Add release workflow information to README (#19)
* docs: Add release workflow information to README * Fix typo --------- Co-authored-by: olli <[email protected]>
1 parent 1675e9c commit bd235da

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Install it from [PyPI](https://pypi.org/project/ahlbatross/):
2424
pip install ahlbatross
2525
```
2626

27-
## Development setup
27+
## Development Setup
2828

2929
To set up the python development environment, install the required dependencies via
3030

@@ -41,6 +41,10 @@ tox
4141
Check out our [Python Template Repository](https://github.com/Hochfrequenz/python_template_repository#how-to-use-this-repository-on-your-machine)
4242
for detailed descriptions and step-by-step instructions.
4343

44+
### Release Workflow / CD
45+
To publish a new version of this library on PyPI [create a new release](https://github.com/Hochfrequenz/ahlbatross/releases/new).
46+
Use semantic versioning with leading `v`, e.g. `v1.2.3` and please include at least the autogenerated release notes.
47+
4448
## Contribute
4549

4650
Feel free to contribute to this project by opening a pull request against the main branch.

0 commit comments

Comments
 (0)