README.md

Nulogy Integrate GitHub Action

Fork of the cirrus-actions/rebase repo for integrating a PR

Example Usage

1. Add the following setup code to .github/workflows/integrate.yml.

   name: Integrate
   
   on:
     issue_comment:
       types: [created]
   
   jobs:
     integrate:
       name: Integrate
       if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/integrate')
       runs-on: ubuntu-latest
       steps:
         - uses: actions/[email protected]
         - uses: nulogy/integrate-action@master
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_MERGING_TOKEN }}
     always_job:
       name: Aways run job
       runs-on: ubuntu-latest
       steps:
         - name: Always run
           run: echo "This job is used to prevent the workflow to fail when all other jobs are skipped."

2. Add GITHUB_MERGING_TOKEN as a secret in "Settings" > "Secrets". NOTE: The GITHUB_MERGING_TOKEN must allow merging the PR into the BASE branch of the PR which is typically master.

3. Make sure "Allow merge commits" is checked under the "Merge button" section in your repo settings.

Then on a PR, type /integrate into the comments section.

This will fail if the HEAD branch is not rebaseable on top of the BASE branch of the PR and the HEAD branch needs to be rebased.