Combine PRs #41
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
| name: "Combine PRs" | |
| # Controls when the action will run - in this case triggered manually | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| branchPrefix: | |
| description: "Branch prefix to find combinable PRs based on" | |
| required: true | |
| type: string | |
| default: dependabot | |
| mustBeGreen: | |
| description: "Only combine PRs that are green (status is success)" | |
| type: boolean | |
| required: true | |
| default: true | |
| combineBranchName: | |
| description: "Name of the branch to combine PRs into" | |
| type: string | |
| required: true | |
| default: "combine-prs-branch" | |
| ignoreLabel: | |
| description: "Exclude PRs with this label" | |
| type: string | |
| required: true | |
| default: nocombine | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "combine-prs" | |
| combine-prs: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| - uses: actions/github-script@v3 | |
| id: fetch-branch-names | |
| name: Fetch branch names | |
| with: | |
| github-token: ${{secrets.GITHUB_TOKEN}} | |
| script: | | |
| const pulls = await github.paginate('GET /repos/:owner/:repo/pulls', { | |
| owner: context.repo.owner, | |
| repo: context.repo.repo | |
| }); | |
| branches = []; | |
| prs = []; | |
| base_branch = null; | |
| for (const pull of pulls) { | |
| const pr = pull['number'] | |
| const branch = pull['head']['ref']; | |
| console.log('Pull ' + pr + ' for branch: ' + branch); | |
| if (branch.startsWith('${{ github.event.inputs.branchPrefix }}')) { | |
| console.log('Branch matched: ' + branch); | |
| statusOK = true; | |
| if(${{ github.event.inputs.mustBeGreen }}) { | |
| console.log('Checking green status: ' + branch); | |
| const prDetails = await github.pulls.get({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| pull_number: pr, | |
| }); | |
| console.log('PR mergeable? ' + prDetails.data.mergeable); | |
| if(!prDetails.data.mergeable) { | |
| console.log('Discarding ' + branch); | |
| statusOK = false; | |
| } | |
| } | |
| console.log('Checking labels: ' + branch); | |
| const labels = pull['labels']; | |
| for(const label of labels) { | |
| const labelName = label['name']; | |
| console.log('Checking label: ' + labelName); | |
| if(labelName == '${{ github.event.inputs.ignoreLabel }}') { | |
| console.log('Discarding ' + branch + ' with label ' + labelName); | |
| statusOK = false; | |
| } | |
| } | |
| if (statusOK) { | |
| console.log('Adding branch to array: ' + branch); | |
| branches.push(branch); | |
| prs.push('#' + pull['number'] + ' ' + pull['title']); | |
| base_branch = pull['base']['ref']; | |
| } | |
| } | |
| } | |
| if (branches.length == 0) { | |
| core.setFailed('No PRs/branches matched criteria'); | |
| return; | |
| } | |
| core.setOutput('base-branch', base_branch); | |
| core.setOutput('prs-string', prs.join('\n')); | |
| combined = branches.join(' ') | |
| console.log('Combined: ' + combined); | |
| return combined | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| # Creates a branch with other PR branches merged together | |
| - name: Created combined branch | |
| env: | |
| BASE_BRANCH: ${{ steps.fetch-branch-names.outputs.base-branch }} | |
| BRANCHES_TO_COMBINE: ${{ steps.fetch-branch-names.outputs.result }} | |
| COMBINE_BRANCH_NAME: ${{ github.event.inputs.combineBranchName }} | |
| run: | | |
| echo "$BRANCHES_TO_COMBINE" | |
| sourcebranches="${BRANCHES_TO_COMBINE%\"}" | |
| sourcebranches="${sourcebranches#\"}" | |
| basebranch="${BASE_BRANCH%\"}" | |
| basebranch="${basebranch#\"}" | |
| git config pull.rebase false | |
| git config user.name github-actions | |
| git config user.email [email protected] | |
| git branch $COMBINE_BRANCH_NAME $basebranch | |
| git checkout $COMBINE_BRANCH_NAME | |
| git pull origin $sourcebranches --no-edit | |
| git push origin $COMBINE_BRANCH_NAME | |
| # Creates a PR with the new combined branch | |
| - uses: actions/github-script@v3 | |
| name: Create Combined Pull Request | |
| env: | |
| PRS_STRING: ${{ steps.fetch-branch-names.outputs.prs-string }} | |
| with: | |
| github-token: ${{secrets.GITHUB_TOKEN}} | |
| script: | | |
| const prString = process.env.PRS_STRING; | |
| const body = 'This PR was created by the Combine PRs action by combining the following PRs:\n' + prString; | |
| await github.pulls.create({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| title: 'Combined PR', | |
| head: '${{ github.event.inputs.combineBranchName }}', | |
| base: '${{ steps.fetch-branch-names.outputs.base-branch }}', | |
| body: body | |
| }); |