update: Improved versioning and added examples for commit messages

This commit is contained in:
Jan Jambor 2024-05-16 11:12:50 +02:00
parent 6399c627f7
commit 4b84fa43ef
2 changed files with 6 additions and 3 deletions

View file

@ -17,6 +17,9 @@ The idea is to get rather automated release notes. To have this as easy as possi
- `delete:` - for removed functionality
- Everything else will be ignored
- A git commit example for a new feature: `git commit -m "new: added new feature"`
- A git commit example for something you don't want to show in the release notes (omit any of the keywords at the beginning): `git commit -m "updated readme"`
- tags for each version, we will output only the change log from the last and second last tag
- you can add tags with `git tag -a <tag> -m "<message>"`

View file

@ -3,17 +3,17 @@
We utilize a hybrid versioning scheme, blending [Semantic Versioning](https://semver.org/) with [CalVer](https://calver.org/):
```text
YYYY-MM-DD-[RELEASE_TYPE]-N
YYYY-MM-[RELEASE_TYPE]-N
```
Components of the version number are as follows:
- `YYYY`, `MM`, `DD`: Year, month, and day of release, respectively.
- `YYYY`, `MM`: Year and month of release.
- `RELEASE_TYPE`: Specifies the development stage:
- `alpha`: Initial testing phase.
- `beta`: Near-complete features, further testing.
- `rc` (release candidate): Stability testing, bug fixes.
- `final`: Production-ready release.
- `N`: Incremental release number for multiple releases on the same date.
- `N`: Incremental release number for multiple releases within one month.
Guidelines:
- Automated scripts should generate version numbers to avoid errors.