Autobuild: Make Changelog generation an extra step #2480
Milestone
Comments
|
@jamulussoftware/maindevelopers Did this happen, does anyone know? |
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
This was previously done as part of the variable extraction step. It's rather surprising to have a script with the name "analyze*" write to some Changelog file. Therefore, move all of the generation to the same abstraction level (Github workflow). Fixes jamulussoftware#2480
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
5 tasks
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
Previously, the autobuild changelog (autoLatestChangelog.md) which is used for the Github release body, was generated as part of the "analyse_git_reference.py" script. It does not seem logical for an analysis script to have a side effect of producing a Changelog file. Also, the file name (autoLatestChangelog.md) was hardcoded in two places and had to match (workflow + script). With this commit, the changelog generation call (.github/actions_scripts/getChangelog.pl) is moved to the workflow. This follows the principle of least surprise and moves the output file name usage to a single file (the workflow). Fixes: jamulussoftware#2480
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
5 tasks
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
Previously, the autobuild changelog (autoLatestChangelog.md) which is used for the Github release body, was generated as part of the "analyse_git_reference.py" script. It does not seem logical for an analysis script to have a side effect of producing a Changelog file. Also, the file name (autoLatestChangelog.md) was hardcoded in two places and had to match (workflow + script). With this commit, the changelog generation call (.github/actions_scripts/getChangelog.pl) is moved to the workflow. This follows the principle of least surprise and moves the output file name usage to a single file (the workflow). Fixes: jamulussoftware#2480
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
hoffie
added a commit
to hoffie/jamulus
that referenced
this issue
Jun 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What is the current behaviour and why should it be changed?
The Changelog is currently generated by
analyze_git_references.py. This is surprising...Describe possible approaches
Changelog generation should be an individual step.
Has this feature been discussed and generally agreed?
https://github.com/jamulussoftware/jamulus/pull/2470/files#r822584276
The text was updated successfully, but these errors were encountered: