Skip to content

[skip changelog] Use major version ref for actions/github-script action #1404

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

Merged
merged 1 commit into from
Aug 20, 2021
Merged

[skip changelog] Use major version ref for actions/github-script action #1404

merged 1 commit into from
Aug 20, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 20, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Infrastructure enhancement

  • What is the current behavior?

The actions/github-script GitHub Actions action dependency of the "github-stats" workflow is pinned to the patch version. This means it must be updated every time a release of the action is made.

  • What is the new behavior?

Use of the major version ref will cause the workflow to automatically benefit from ongoing development to its actions/github-script GitHub Actions action dependency at each patch or minor release without any intervention from a maintainer, up until such time as a new major release is made. Dependabot will submit a PR at that time, which will serve as the notification that a newer version is available. At that time, the maintainer should evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before manually updating the major ref (i.e., uses: actions/github-script@v5).

Not breaking.

  • Other information:

Alternative to #1403

Information about the major version ref approach:
https://docs.github.com/en/actions/creating-actions/about-actions#using-release-management-for-actions

…tion

Use of the major version ref will cause the workflow to benefit from ongoing development to its `actions/github-script`
GitHub Actions action dependency at each patch or minor release up until such time as a new major release is made.
Dependabot will submit a PR at that time, which will serve as the notification that a newer version is available. At that
time, the maintainer should evaluate whether any changes to the workflow are required by the breaking change that
triggered the major release before manually updating the major ref (i.e., `uses: actions/github-script@v5`).
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 20, 2021
@per1234 per1234 requested review from silvanocerza and rsora August 20, 2021 12:36
@per1234 per1234 merged commit 3aceff5 into arduino:master Aug 20, 2021
@per1234 per1234 deleted the github-script-ref branch August 20, 2021 12:49
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants