(PUP-12055) Build references on commit to main #9472
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When a commit is pushed to main, build all of the references, including man pages. If the only changes are due to SHA and dates, then do nothing. Otherwise, commit all of the references and man pages. The action is only triggered when a commit is pushed to main, but not on pull requests so that we don't have to worry about untrusted inputs. The action is only triggered when the repo owner is puppetlabs, so it won't trigger on forks. The action uses full SHAs for the pandoc and add-and-commit actions. If changes are detected, the action creates a commit whose author is GitHub Actions <[email protected]> with message: Update references [no-promote] And pushes the commit to the main branch. It uses the repository's GITHUB_TOKEN to accomplish this. We don't need to worry about recursive workflow runs[1]: When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN ... will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs. [1] https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow
|
I tested this out as best I could on my puppet fork. This run detected no changes were necessary. From the branch history you can see that no automated commits were made between e5b8639 and 39b98ed. This run detected |
mhashizume
approved these changes
Sep 10, 2024
|
@joshcooper It looks like this failed due to branch protections: https://github.com/puppetlabs/puppet/actions/runs/10800909036/job/29959927892 I assume we can add an exemption, but I'm not sure that the user that pushes to main is able to do that. Maybe we need to try having another user be the one that pushes? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a commit is pushed to main, build all of the references, including man pages. If the only changes are due to SHA and dates, then do nothing. Otherwise, commit all of the references and man pages.
The action is only triggered when a commit is pushed to main, but not on pull requests so that we don't have to worry about untrusted inputs.
The action is only triggered when the repo owner is puppetlabs, so it won't trigger on forks.
The action uses full SHAs for the pandoc and add-and-commit actions.
If changes are detected, the action creates a commit whose author is GitHub Actions [email protected] with message:
And pushes the commit to the main branch. It uses the repository's GITHUB_TOKEN to accomplish this. We don't need to worry about recursive workflow runs[1]:
[1] https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow