Check the documentation once to verify the release process

Signed-off-by: Christian Wolf <github@christianwolf.email>
This commit is contained in:
Christian Wolf 2024-05-19 18:48:38 +02:00
Родитель a3fa7c7cad
Коммит 36ca9c228d
1 изменённых файлов: 8 добавлений и 1 удалений

Просмотреть файл

@ -32,7 +32,7 @@ The process depends if you want to create an actual new release or just a pre-re
Both variants require that a python script is called to build the changelog from the various files.
Please install this first.
#### Installation of script (onlly once needed)
#### Installation of script (only once needed)
Go to the folder `.helper/changelog` in a console.
Create a virtual python environment valled `venv`.
@ -42,6 +42,13 @@ Also, you need a personal access token for your GitHub account to prevent API ra
Just create a token and put it in `.helpers/changelog/token`.
Do not commit this file ever!
#### Activate the virtual environemnt
The venv has a means of enabling it.
It depends on your shell and OS about the detailed steps.
For example, in Bash, you have to `source .helpers/changelog/venv/bin/activate`.
Adjust to your setup.
#### Update the changelog for a release
There is a convinence script availabe at `.helper/changelog/create-changelog-release.sh`.