update: Move chapter release Notes to Versioning part of the documentation.

This commit is contained in:
Jan Jambor 2024-05-30 22:03:19 +02:00
parent 2fd9f69d47
commit 5b84397754
2 changed files with 3 additions and 25 deletions

View file

@ -6,29 +6,6 @@ Best practices and guidelines for writing code documentation.
All documentation should be easy maintain and accessible. Easy formats should be preffered over more complex ones. All documentation should be easy maintain and accessible. Easy formats should be preffered over more complex ones.
## Release Notes
The idea is to get rather automated release notes. To have this as easy as possible, we need:
- key words for the kind of change we applied:
- `new:` - for newly added functionality
- `update:` - for updated functionality
- `fix:` - for fixed functionality
- `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>"`
[resources/scripts/release-notes.bash](resources/scripts/release-notes.bash) is an example bash script to generate the release notes. You can run it with the following command:
```bash
bash resources/scripts/release-notes.bash
```
## PlantUML ## PlantUML
Create png images from PlantUML files using the following command: Create png images from PlantUML files using the following command:

View file

@ -53,8 +53,9 @@ The idea is to get rather automated release notes. To have this as easy as possi
- `delete:` - for removed functionality - `delete:` - for removed functionality
- Everything else will be ignored - 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 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"` - 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"`.
- In general, write meaningful commit messages. Avoid generic stuff like "new version", "updated readme", "enhanced wording" etc. Try to put yourself in the shoes of someone who has to understand what you did without looking at the whole code or document.
[resources/scripts/release-notes.bash](resources/scripts/release-notes.bash) is an example bash script to generate the release notes. You can run it with the following command: [resources/scripts/release-notes.bash](resources/scripts/release-notes.bash) is an example bash script to generate the release notes. You can run it with the following command: