automatically generate release notes
Since we will make gitlab releases based on git tags, we need to automatically generate release notes as well.
Release jobs examples:
- based on git tags
- pass package name to release job as env variable to include it in release as asset
Tools/doc to investigate:
-
blender script to generate release notes -> need to understand what is the
lts_issue
python package - blender commit convention
- mkdocstring commit convention and keep a changelog
- git-changelog used by mkdocstring
- towncrier used in CTAO template project
- Thomas repo to generate release notes
Tasks:
-
test the different tools, chose a solution
A first version to test some stuff ha been designed and is available at : ReleaseNoteProject. It has been designed on a workflow based on the CI : everytime a new tag is released, a release version is generated by gitlab.
Edited by Vincent Pollet