Skip to content

Commit b002867

Browse files
authored
doc: mention release workflow (#12)
* doc: mention release workflow * Apply suggestions from code review
1 parent 8be4349 commit b002867

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ edifact = await client.bo4e_to_edifact(boney_comb, EdifactFormatVersion.FV2310)
9090
## Development
9191
For development of this library, follow the instructions in our [Python Template Repository](https://github.com/Hochfrequenz/python_template_repository).
9292

93+
### Release (CI/CD)
94+
95+
To release a new version of this library, [create a new release](https://github.com/Hochfrequenz/TransformerBeeClient.py/releases/new) in GitHub.
96+
Make sure its tag starts with `v` and the version number, e.g. `v1.2.3`.
97+
Releases are not restricted to the main branch but we prefer them to happen there.
98+
9399
## Contribute
94100
You are very welcome to contribute to this template repository by opening a pull request against the main branch.
95101

0 commit comments

Comments
 (0)