https://github.com/jb3/ff_bot
A GitHub bot to fast-forward merge PRs onto the default branch.
https://github.com/jb3/ff_bot
Last synced: 4 months ago
JSON representation
A GitHub bot to fast-forward merge PRs onto the default branch.
- Host: GitHub
- URL: https://github.com/jb3/ff_bot
- Owner: jb3
- License: apache-2.0
- Created: 2024-06-13T20:55:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T13:55:04.000Z (almost 2 years ago)
- Last Synced: 2025-10-05T16:03:24.870Z (8 months ago)
- Language: Elixir
- Size: 62.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fast Forward Bot
A GitHub bot allowing for quick and easy fast-forward merges triggered by PR
comments.
You may want to use this application if you want to rebase your commits to your
master branch from within GitHub whilst preserving author signature information
and avoiding the rewriting of commits.
## Deployment
### Creating the application
Follow the guide [here](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) to create a new GitHub app.
The following permissions are required:
- Contents: Read & Write
- Issues: Read & Write
- Pull Requests: Read & Write
The following webhook events must be selected:
- Issue comment
Set the webhook URL to `https://your-prod-domain.com/hook` and select a secure
client secret.
Once created, generate a client secret and keep a hold of this value for later.
### Deployment
A Docker image is published at [`ghcr.io/jb3/ff_bot:latest`](https://ghcr.io/jb3/ff_bot) which can be used to
deploy this application.
The following environment variables must be set:
| Variable | Description |
|-------------------------|---------------------------------------------------------------------------------------------------------------------|
| `GITHUB_WEBHOOK_SECRET` | A secure secret configured in GitHub and your app to validate webhook payloads. Same as the preference set earlier. |
| `GITHUB_CLIENT_ID` | The client ID of your created GitHub app |
| `GITHUB_CLIENT_SECRET` | The client secret certificate of your GitHub app used to sign token requests. |
You can also optionally set these variables:
| Variable | Description | Default |
|--------------------|------------------------------------------------------------------------------------------|----------------------|
| `FF_POLICY_FILE` | The file to read for policy on who can perform merges | `.github/ff-bot.yml` |
| `FF_LISTEN_PORT` | The HTTP port for the service to listen on | 4000 |
| `FF_NO_PROPAGANDA` | Disable all team encouragement messages generated by the bot. | |
## Usage
Once deployed, follow GitHub's instructions to install to your own
account/organisation and select the repositories to use.
For a repository to use it, it must have a review policy at `.github/ff-bot.yml`
(or whatever you have set `FF_POLICY_FILE` to).
An example policy looks like this:
``` yaml
users:
- jb3
teams:
- python-discord/devops
```
Once a user wants to merge a PR, all they have to do is run `/merge` in the PR
comments. If the branch is up to date the merge will take place, if not then the
bot will reply with the branch status.
For the merge to complete, the user must be in the policy file directly or in a
team mentioned in the policy file.
Providing the user is in the policy file and the branch in question is up to
date with main (i.e. is only "ahead" of main, no divergence), the merge will
take place and GitHub will automatically close the Pull Request as all commits
are now present on your primary branch.