Update README and git-release script to clarify multi-project support and tag format

This commit is contained in:
2025-11-01 18:10:26 +01:00
parent 2e507d50e7
commit f35f25e73f
2 changed files with 44 additions and 16 deletions

View File

@@ -3,11 +3,20 @@
Minimal tool to create and publish Git release tags following the vX.Y.Z format.
## Usage
- From the repository root: `./git-release`
- The script creates an annotated tag and pushes it to the configured remote.
- If the script is in your PATH, you can run it directly with `git release`
**Single project (default):**
- From the repository root: `./git-release` or `git release`
- Creates tags in the format `vX.Y.Z`
**Multi-project:**
- From the repository root: `./git-release <projectname>` or `git release <projectname>`
- Creates tags in the format `<projectname>-vX.Y.Z`
- Useful for monorepos with multiple independent release cycles
The script creates an annotated tag and pushes it to the configured remote.
## Example
```
$ git release
📦 Current version: v0.0.0