PR を自動的にリベースする GitHub アクション

インストール後、 /rebaseコメントを付けるだけでアクションがトリガーされます。

リベースアクション

インストール

アクションを構成するには、 .github/workflows/rebase.ymlワークフローファイルに次の行を追加するだけです。

 name : Automatic Rebase
on :
  issue_comment :
    types : [created]
jobs :
  rebase :
    name : Rebase
    runs-on : ubuntu-latest
    if : >-
      github.event.issue.pull_request != '' && 
      (
        contains(github.event.comment.body, '/rebase') || 
        contains(github.event.comment.body, '/autosquash')
      )
    steps :
      - name : Checkout the latest code
        uses : actions/checkout@v3
        with :
          token : ${{ secrets.GITHUB_TOKEN }}
          fetch-depth : 0 # otherwise, you will fail to push refs to dest repo
      - name : Automatic Rebase
        uses : cirrus-actions/[email protected]
        with :
          autosquash : ${{ contains(github.event.comment.body, '/autosquash') || contains(github.event.comment.body, '/rebase-autosquash') }}
        env :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}

注: リベースアクションが成功した後に GitHub アクションが自動的に再実行されるようにするには、 actions/checkout@v2およびcirrus-actions/[email protected]にパーソナルアクセストークンを使用します。詳細については、次の説明を参照してください。

例

... 
    - name : Checkout the latest code
      uses : actions/checkout@v3
      with :
        token : ${{ secrets.PAT_TOKEN }}
        fetch-depth : 0 # otherwise, you will fail to push refs to dest repo
    - name : Automatic Rebase
      uses : cirrus-actions/[email protected]
      env :
        GITHUB_TOKEN : ${{ secrets.PAT_TOKEN }}

実行しているアクションが特定のプルリクエストを直接参照していない場合は、オプションでリベースするブランチの PR 番号を指定することもできます。

    - name : Automatic Rebase
      uses : cirrus-actions/[email protected]
      env :
        GITHUB_TOKEN : ${{ secrets.PAT_TOKEN }}
        PR_NUMBER : 1245

アクションを呼び出せる人を制限する

コメントのauthor_associationフィールドを使用して、アクションを呼び出すことができるユーザーを制限し、他のユーザーのリベースをスキップすることができます。ワークフローファイルのifステートメントに式github.event.comment.author_association == 'MEMBER'を追加するだけです。 author_associationで使用可能なすべての値のリストについては、ドキュメントを参照してください。

GitHub はオプションで、リベース後に既存のレビューを自動的に却下することもできるため、再度再承認する必要があり、テストワークフローがトリガーされます。リポジトリで[設定] > [ブランチ] > [ブランチ保護ルール] > [マージ前にプルリクエストのレビューを要求する] > [新しいコミットがプッシュされたときに古いプルリクエストの承認を破棄] で設定します。

拡大する

追加情報