A GitHub action based on Peter Evans' Rebase Pulls to rebase pull requests in a repository.

You need to create an .yml file, say, rebase-pull-requests.yml, in directory .github/workflows to configure the action. A typical configuration should look like following:

name: Rebase Pull Requests
on:
  push:
    branches: '**'
jobs:
  rebase:
    runs-on: ubuntu-latest
    steps:
      - uses: linhbn123/rebase-pull-requests@v1.0.1

This configuration will trigger the action on every push to any branch. Let's say you have a pull request with source branch feature/my-feature and target branch main. If there is a new commit on main (e.g. another pull request is merged), then feature/my-feature will be rebased on it.

If you wish to trigger the action only for a specific branch, say, main, then you can use the following configuration:

name: Rebase Pull Requests
on:
  push:
    branches: [main]
jobs:
  rebase:
    runs-on: ubuntu-latest
    steps:
      - uses: linhbn123/rebase-pull-requests@v1.0.1

Notes:

• The operation is not cascaded. If you have a chain of pull requests, say, A <- B <- C, then a commit to A will trigger a rebase for B on A and will lead to new commits to B. These commits, however, won't trigger any rebase for C on B. See here for details.
• To see the statuses of action runs, open Actions view in your repository. Note that a successful run doesn't mean the rebase operation itself is successful. Check the log and the pull requests to confirm.
• The statuses of rebase operations are also displayed as badges next to commits.
• If the rebase operation is unsuccessful, the action will add a comment to the pull request. You can check the list of files in conflict at the bottom of the page and handle them yourself.
• If you setup email notification properly, you should be able to see the statuses (including success and failure) of the rebase operations in your inbox.
• If your branch is rebased automatically and you have local commits, your attempt to push to the remote branch will be rejected. In that case, you can rebase your local commits on latest changes by executing git pull --rebase.

MIT