jambor.pro/docs-onboarding
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feature: add script for release notes

Browse source
This commit is contained in:
Jan 2024-05-12 13:34:47 +02:00
parent ac62e47083
commit 783bfb47dc
2 changed files with 41 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
documentation-guidelines.md
View file

@ -2,6 +2,23 @@
Best practices and guidelines for writing code documentation.
## 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:
- `feature:` - for newly added functionality
- `fix:` - for bugfixes
- `nonotes:` - for git commits we don't want to see in the release notes
- tags for each version, we will output only the change log from the last and second last tag
[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
Create png images from PlantUML files using the following command: