Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autobuild: Clean up redundant variables in workflow definition #2584

Merged
merged 1 commit into from
Apr 9, 2022

Conversation

hoffie
Copy link
Member

@hoffie hoffie commented Apr 6, 2022

Short description of changes

  • Autobuild: Don't hardcode python path in analyse_git_reference.py

  • Autobuild: Move Changelog generation to the workflow
    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).

  • Autobuild: Improve variable naming/coding style in analyse_git_reference.py

  • Autobuild: Move .github/action_scripts to .github/autobuild
    This also renames the two scripts to better reflect what they do.

  • Autobuild: Drop redundant github.workspace variable reference in workflow

Edit: This PR lacked most of the changes above. See #2656 for a re-submission with the missing parts.

CHANGELOG: (Autobuild: Clean up redundant variables in workflow definition; to be condensed with other Autobuild refactoring entries)

Context: Fixes an issue?

I think it had been mentioned elsewhere

  • that .github/action_scripts/* should be moved to .github/autobuild/ instead, as that's where they are used now
  • that an analyze_something script is not supposed to have the side effect of writing a (Changelog) file

Does this change need documentation? What needs to be documented and how?

No.

Status of this Pull Request

Ready.

What is missing until this pull request can be merged?

Reviews.

Checklist

@hoffie hoffie added this to the Release 3.9.0 milestone Apr 6, 2022
@hoffie hoffie requested a review from ann0see April 6, 2022 20:45
Copy link
Member

@ann0see ann0see left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks sane.

@hoffie hoffie requested a review from pljones April 6, 2022 21:39
@hoffie hoffie force-pushed the autobuild-action-scripts branch from c08811b to 89b67f0 Compare April 7, 2022 20:58
@hoffie
Copy link
Member Author

hoffie commented Jun 18, 2022

Somehow this PR lost most of the supposed content before merge (maybe due to a bad rebase). I'll re-submit what's left.

@hoffie hoffie changed the title Autobuild: Improve and reorganize git/Changelog scripts Autobuild: Clean up redundant variables in workflow definition Jun 18, 2022
hoffie added a commit that referenced this pull request Jun 19, 2022
Autobuild: Improve and reorganize git/Changelog scripts (re-submission of #2584)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants