Skip to content

feat(actions/create-and-merge-pull-request): add outputs for final ref and sha #529

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.

Sign up for GitHub

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
neilime merged 1 commit into from
May 19, 2026
Merged

feat(actions/create-and-merge-pull-request): add outputs for final ref and sha #529

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 131 additions & 60 deletions actions/create-and-merge-pull-request/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ inputs:
description: "The commit message for the pull request"
required: true

outputs:
merged-ref:
description: "The fully qualified ref updated by the merge."
value: ${{ steps.merge-pull-request.outputs.merged-ref }}
merged-sha:
description: "The commit SHA at the merged ref after the merge completes."
value: ${{ steps.merge-pull-request.outputs.merged-sha }}

runs:
using: "composite"
steps:
Expand Down Expand Up @@ -67,84 +75,147 @@ runs:
author: ${{ steps.github-actions-bot-user.outputs.name }} <${{ steps.github-actions-bot-user.outputs.email }}>
committer: ${{ steps.github-actions-bot-user.outputs.name }} <${{ steps.github-actions-bot-user.outputs.email }}>

- id: wait-for-pull-request-mergeable-by-admin
- id: merge-pull-request
name: Merge pull request
if: steps.create-pull-request.outputs.pull-request-number && steps.create-pull-request.outputs.pull-request-operation != 'closed'
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
GH_TOKEN: ${{ inputs.github-token }}
PULL_REQUEST_NUMBER: ${{ steps.create-pull-request.outputs.pull-request-number }}
with:
github-token: ${{ inputs.github-token }}
script: |
let attempts = 0;
const maxAttempts = 10;
const requiredWorkflowsError = 'Required workflow';
const repository = `${context.repo.owner}/${context.repo.repo}`;
const getRetryDelayMs = attempt => Math.min(1000 * (2 ** attempt), 10000);

const sleep = delayMs => new Promise(resolve => setTimeout(resolve, delayMs));

const waitFor = async ({
run,
isComplete,
shouldRetry = () => true,
onAttempt = () => {},
getRetryMessage,
getFailureMessage,
getTimeoutMessage,
}) => {
for (let attempt = 0; attempt < maxAttempts; attempt++) {
const result = await run();

onAttempt(result);

if (isComplete(result)) {
return result;
}

if (!shouldRetry(result)) {
throw new Error(getFailureMessage(result));
}

const retryDelayMs = getRetryDelayMs(attempt);
core.debug(getRetryMessage(result, retryDelayMs));
await sleep(retryDelayMs);
}

const pullNumberRaw = process.env.PULL_REQUEST_NUMBER ?? '';
if (!/^[0-9]+$/.test(pullNumberRaw)) {
throw new Error(`Invalid pull request number: ${pullNumberRaw}`);
}
const pullNumber = Number.parseInt(pullNumberRaw, 10);
throw new Error(getTimeoutMessage());
};

while (attempts < maxAttempts) {
const { data: { mergeable, mergeable_state } } = await github.rest.pulls.get({
const parsePullRequestNumber = pullNumberRaw => {
if (!/^[0-9]+$/.test(pullNumberRaw)) {
throw new Error(`Invalid pull request number: ${pullNumberRaw}`);
}

return Number.parseInt(pullNumberRaw, 10);
};

const getPullRequest = async pullNumber => {
const { data: pullRequest } = await github.rest.pulls.get({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: pullNumber,
});

if (mergeable === true) {
core.setOutput('is-mergeable', true);
return;
}

core.debug(`Pull request is not mergeable, mergeable_state: ${mergeable_state}`);
return pullRequest;
};

const waitForMergeablePullRequest = pullNumber =>
waitFor({
run: () => getPullRequest(pullNumber),
isComplete: pullRequest => pullRequest.mergeable === true,
onAttempt: pullRequest => {
if (pullRequest.mergeable !== true) {
core.debug(`Pull request is not mergeable, mergeable_state: ${pullRequest.mergeable_state}`);
}
},
getRetryMessage: (_pullRequest, retryDelayMs) => `Retrying mergeability check in ${retryDelayMs}ms...`,
getFailureMessage: () => `Pull request #${pullNumber} cannot be retried because it is not mergeable.`,
getTimeoutMessage: () => `Pull request #${pullNumber} is not mergeable after ${maxAttempts} attempts`,
});

await new Promise(resolve => setTimeout(resolve, 5000));
attempts++;
}
const mergePullRequest = async pullNumber => {
core.debug(`Merging pull request #${pullNumber} for repository ${repository}...`);

const { exitCode, stdout, stderr } = await exec.getExecOutput(
'gh',
[
'pr',
'merge',
'-R',
repository,
'--rebase',
'--admin',
String(pullNumber),
],
{
env: process.env,
ignoreReturnCode: true,
silent: true,
},
);

return {
mergeExitCode: exitCode,
mergeOutputs: [stdout, stderr].filter(Boolean).join('\n').trim(),
};
};

const verifyMergedPullRequest = async (pullNumber, mergeOutputs) => {
const pullRequest = await waitFor({
run: () => getPullRequest(pullNumber),
isComplete: currentPullRequest => Boolean(
currentPullRequest.merged
&& currentPullRequest.base.ref
&& currentPullRequest.merge_commit_sha,
),
getRetryMessage: (_pullRequest, retryDelayMs) => `Pull request merge has not been reflected by the REST API yet, retrying in ${retryDelayMs}ms...`,
getFailureMessage: () => `Pull request merge verification stopped before completion: ${mergeOutputs}`,
getTimeoutMessage: () => `Pull request merge succeeded but timed out while waiting for REST API verification: ${mergeOutputs}`,
});

core.error('Pull request is not mergeable');
core.setOutput('merged-ref', `refs/heads/${pullRequest.base.ref}`);
core.setOutput('merged-sha', pullRequest.merge_commit_sha);
};

const pullNumber = parsePullRequestNumber(process.env.PULL_REQUEST_NUMBER ?? '');

await waitForMergeablePullRequest(pullNumber);

const { mergeOutputs } = await waitFor({
run: () => mergePullRequest(pullNumber),
isComplete: ({ mergeExitCode }) => mergeExitCode === 0,
shouldRetry: ({ mergeOutputs }) => mergeOutputs.includes(requiredWorkflowsError),
onAttempt: ({ mergeExitCode, mergeOutputs }) => {
core.debug(`Merge outputs: ${mergeOutputs}`);
core.debug(`Merge exit code: ${mergeExitCode}`);
},
getRetryMessage: (_result, retryDelayMs) => `Pull request is not mergeable yet because some of required workflow check issues, retrying in ${retryDelayMs}ms...`,
getFailureMessage: ({ mergeOutputs }) => `Failed to merge pull request: ${mergeOutputs}`,
getTimeoutMessage: () => `Failed to merge pull request after ${maxAttempts} attempts`,
});

- name: Merge pull request
if: steps.wait-for-pull-request-mergeable-by-admin.outputs.is-mergeable
shell: bash
env:
GH_TOKEN: ${{ inputs.github-token }}
PULL_REQUEST_NUMBER: ${{ steps.create-pull-request.outputs.pull-request-number }}
run: |
set +e

if ! [[ "$PULL_REQUEST_NUMBER" =~ ^[0-9]+$ ]]; then
echo "::error::Invalid pull request number: $PULL_REQUEST_NUMBER"
exit 1
fi

ATTEMPTS=0
MAX_ATTEMPTS=10
REQUIRED_WORKFLOWS_ERROR="Required workflow"

while [ $ATTEMPTS -lt $MAX_ATTEMPTS ]; do
echo "::debug::Merging pull request #${PULL_REQUEST_NUMBER} for repository ${{ github.repository }}..."
MERGE_OUTPUTS=$(gh pr merge -R "${{ github.repository }}" --rebase --admin "${PULL_REQUEST_NUMBER}" 2>&1)
MERGE_EXIT_CODE=$?
echo "::debug::Merge outputs: $MERGE_OUTPUTS"
echo "::debug::Merge exit code: $MERGE_EXIT_CODE"

if [ "$MERGE_EXIT_CODE" = "0" ]; then
exit 0
fi

if [[ "$MERGE_OUTPUTS" != *"$REQUIRED_WORKFLOWS_ERROR"* ]]; then
echo "::error::Failed to merge pull request: $MERGE_OUTPUTS"
exit 1
fi

echo "::debug::Pull request is not mergeable yet because some of required workflow check issues, retrying in 5 seconds..."
sleep 5
ATTEMPTS=$((ATTEMPTS+1))
done

echo "::error::Failed to merge pull request after $MAX_ATTEMPTS attempts: $MERGE_OUTPUTS"
exit 1
await verifyMergedPullRequest(pullNumber, mergeOutputs);

- name: Cleanup sibling actions
if: ${{ always() }}
Expand Down
Loading