Skip to content

Commit fd0eeed

Browse files
authored
add release info to README (#10)
1 parent 85c0118 commit fd0eeed

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,11 @@ pip install haystack-pydoc-tools
2020
## License
2121

2222
`haystack-pydoc-tools` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
23+
24+
## Release process
25+
To release version `x.y.z`:
26+
27+
1. Manually update the version in `src/haystack_pydoc_tools/__about__.py` (via a PR or a direct push to `main`).
28+
2. From the `main` branch, create a tag locally: `git tag vx.y.z`.
29+
3. Push the tag: `git push --tags`.
30+
4. Wait for the CI to release the package on PyPI.

0 commit comments

Comments
 (0)