xtink4/calibre-plugins
0
0
Fork 0
mirror of https://github.com/crosspoint-reader/calibre-plugins.git synced 2026-04-29 10:26:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

Document automated versioning and release process

Browse Source
This commit is contained in:
Justin Mitchell
2026-02-22 18:42:25 -05:00
parent cdb97030a9
commit 1eb4120970
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+25
View File
@@ -31,6 +31,31 @@ make remove
See [`calibre-customize` docs](https://manual.calibre-ebook.com/generated/en/calibre-customize.html) for more options.
### Releasing
The version is read from the `version` tuple in `crosspoint_reader/driver.py`.
```sh
# Bump the version (updates driver.py in place)
make bump-patch # 1.0.0 -> 1.0.1
make bump-minor # 1.0.0 -> 1.1.0
make bump-major # 1.0.0 -> 2.0.0
# Package the plugin into a zip (crosspoint_reader-vX.Y.Z.zip)
make zip
# Create a GitHub release with the zip attached (runs `make zip` first)
make release
```
`make release` uses the [GitHub CLI](https://cli.github.com/) (`gh`) to create a tagged release with auto-generated notes.
Typical workflow:
1. `make bump-patch` (or `bump-minor` / `bump-major`)
2. Commit the version change
3. `make release`
### Project structure
```