build: set up workflow to automatically manage/mirror the v0.16.1 branch #7577
Conversation
In this PR, we set up an automated Github Actions workflow to merge any PR that has a milestone of v0.16.1 into the v0.16.1 branch once it has been merged into the master branch. For this to work, we'll need to create a new scoped PAT that gives our normal code review bot the ability to merge PRs into the master branch. Note that with the way this is set up, we only want to merge things in when they have all the checks passed. We might want to also consider `peter-evans/enable-pull-request-automerge` for this task. **NOTE**: The contents of this PR were generated entirely by ChatGPT 🤖.
|
We can use this to handle the merge vs that script fragment: https://github.com/peter-evans/enable-pull-request-automerge A solution that uses that instead (asked it to use the action and modify the solution): name: Merge pull request into v0.16.1
on:
pull_request:
types: [closed]
branches:
- master
milestone:
types: [created, edited]
names:
- 'v0.16.1'
jobs:
create-pr:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Create pull request to merge into v0.16.1
uses: peter-evans/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: v0.16.1
commit-message: Merge pull request #${{ github.event.pull_request.number }}
title: Merge pull request #${{ github.event.pull_request.number }} into v0.16.1
body: |
This pull request was automatically created to merge pull request #${{ github.event.pull_request.number }}
into the v0.16.1 branch because it was merged into the master branch and had the v0.16.1 milestone.
base: v0.16.1
draft: false
enable-automerge:
needs: create-pr
runs-on: ubuntu-latest
steps:
- name: Enable pull request automerge
uses: peter-evans/enable-pull-request-automerge@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
pull-request-number: ${{ steps.create-pr.outputs.pull_request_number }}
merge-method: merge
delete-branch: true
|
|
|
||
| jobs: | ||
| create-pr: | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
I think we need if: github.event.pull_request.merged == true here to make sure this isn't triggered when someone closes the PR without merging (see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-your-pull_request-workflow-when-a-pull-request-merges).
| uses: peter-evans/[email protected] | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| branch: v0.16.1 |
There was a problem hiding this comment.
The branch is called 0-16-1-staging.
| body: | | ||
| This pull request was automatically created to merge pull request #${{ github.event.pull_request.number }} | ||
| into the v0.16.1 branch because it was merged into the master branch and had the v0.16.1 milestone. | ||
| base: v0.16.1 |
There was a problem hiding this comment.
Same here, re branch name.
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v2 |
There was a problem hiding this comment.
Do we need to check out the code here and below? Since all we do is invoke some GitHub APIs.
| const { context } = github; | ||
| const prNumber = context.payload.pull_request.number; | ||
| const headRef = context.payload.pull_request.head.ref; | ||
| const baseRef = 'v0.16.1'; |
There was a problem hiding this comment.
Branch name is wrong here too. Also, not sure what the github.context.payload refers to exactly, wasn't able to find any documentation on it...
Should we perhaps use the action outputs of the previous step instead? https://github.com/peter-evans/create-pull-request#action-outputs
There was a problem hiding this comment.
Or we could just use the following additional step in the create-pr flow:
- name: Enable Pull Request Automerge
run: gh pr merge --merge --auto "1"
env:
GH_TOKEN: ${{ secrets.PAT }}
See https://github.com/peter-evans/enable-pull-request-automerge#enable-pull-request-auto-merge.
In this PR, we set up an automated Github Actions workflow to merge any PR that has a milestone of v0.16.1 into the v0.16.1 branch once it has been merged into the master branch.
For this to work, we'll need to create a new scoped PAT that gives our normal code review bot the ability to merge PRs into the master branch. Note that with the way this is set up, we only want to merge things in when they have all the checks passed. We might want to also consider
peter-evans/enable-pull-request-automergefor this task.NOTE: The contents of this PR were generated entirely by ChatGPT 🤖.