Wait for Required Checks on Protected Branches #269
Conversation
This file contains 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
TriPSs
reviewed
Sep 4, 2024
Comment on lines
+276
to
+298
| async function waitForRequiredChecks(branch) { | ||
| const octokit = github.getOctokit(core.getInput('github-token')) | ||
| const { owner, repo } = github.context.repo | ||
|
|
||
| while (true) { | ||
| const { data: checks } = await octokit.rest.checks.listForRef({ | ||
| owner, | ||
| repo, | ||
| ref: branch, | ||
| }) | ||
|
|
||
| const pendingChecks = checks.check_runs.filter(check => check.status !== 'completed') | ||
|
|
||
| if (pendingChecks.length === 0) { | ||
| core.info('All required checks have passed') | ||
| break | ||
| } | ||
|
|
||
| core.info(`Waiting for ${pendingChecks.length} checks to complete...`) | ||
| await new Promise(resolve => setTimeout(resolve, 30000)) // Wait for 30 seconds before checking again | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Could you move this into the helpers folder?
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.
Description
This PR adds functionality to wait for all required checks to pass before pushing changes when operating on a protected branch. This enhancement improves the reliability of our conventional changelog action, especially in environments with strict branch protection rules.
Changes
is-protected-branchto indicate if the current branch is protected.waitForRequiredChecksfunction to poll the status of required checks.runfunction to incorporate the waiting logic when pushing to a protected branch.is-protected-branchinput.How to Use
To enable this feature, set the
is-protected-branchinput totruein your workflow: