Boomper Bot
GitHub App
Boomper Bot
GitHub App
Bump version numbers in files whenever new releases are published to GitHub. Open source and built with Probot.
Usage
Firstly, you’ll need to install the Boomper GitHub App. This listens out for any releases, or any changes to the configuration.
Then, add a .github/boomper.yml configuration file to the GitHub repository where you publish new releases to.
For example, given the following .github/boomper.yml file:
updates:
- path: README.md
pattern: 'https://someurl.com/(v.*)/download.zip'And given the following README.md file:
Install with `curl https://someurl.com/v1.0.0/download.zip`Then when a new release is published (e.g. v2.0.0), Boomper will update the README.md to:
Install with `curl https://someurl.com/v2.0.0/download.zip`Configuration options
You can configure Boomper using the following key in your .github/bumper.yml file:
| Key | Required | Description |
|---|---|---|
updates |
Required | A list of paths and patterns to update when a new release is published. |
updates.[].path |
Required | The path to the file to update. |
updates.[].pattern |
Required | The regular expression containing a single group, which will be used to match and update the version number in the file. |
updates.[].branch |
Optional | The branch to update. Default is master. |
branches |
Optional | The branches to listen for configuration updates to .github/bumper.yml. Useful if you want to test the app on a pull request branch. Default is "master". |
Boomper also supports Probot Config, if you want to store your configuration files in a central repository.
⚠️ Installation Permissions
Boomper needs to update your files for you, and so it requires write access to the repository you want to automatically update. Please don't just add it to your entire GitHub account! Only add the repositories you want Boomper to update for you.
Developer
Boomper Bot is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Report abuse