Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toolmantim/boomper
Bump version numbers in files whenever new releases are published to GitHub.
https://github.com/toolmantim/boomper
github-app probot-app
Last synced: 25 days ago
JSON representation
Bump version numbers in files whenever new releases are published to GitHub.
- Host: GitHub
- URL: https://github.com/toolmantim/boomper
- Owner: toolmantim
- License: isc
- Created: 2018-06-23T13:03:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T09:35:55.000Z (3 months ago)
- Last Synced: 2024-10-15T04:32:59.785Z (about 1 month ago)
- Topics: github-app, probot-app
- Language: JavaScript
- Homepage: https://github.com/apps/boomper-bot
- Size: 1.2 MB
- Stars: 38
- Watchers: 3
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Bump version numbers in files whenever new releases are published to GitHub. Built with Probot.
---
---
[](https://www.npmjs.com/package/boomper-github-app)
## Usage
Firstly, you’ll need to install the [Boomper GitHub App](https://github.com/apps/boomper-bot). 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:
```yml
updates:
- path: README.md
pattern: 'https://someurl.com/(v.*)/download.zip'
```
And given the following `README.md` file:
```markdown
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:
```markdown
Install with `curl https://someurl.com/v2.0.0/download.zip`
```
## Examples
### [Buildkite Plugin Readmes](https://buildkite.com/docs/agent/v3/plugins)
```yml
updates:
- path: README.md
pattern: 'my-org/my-plugin#(v.*):'
```
## Configuration options
You can configure Boomper using the following key in your `.github/boomper.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 the repository's default branch (e.g. `master`).|
|`branches`|Optional|The branches to listen for configuration updates to `.github/boomper.yml`. Useful if you want to test the app on a pull request branch. Default is `"master"`.|
|`skip-ci`|Optional|Appends `[ci skip]` to commit messages to prevent triggering additional CI builds. Default is `false`.|
## Developing
If you have Node v10+ installed locally, you can run the tests, and a local app, using the following commands:
```sh
# Install dependencies
yarn
# Run the tests
npm test
# Run the app locally
npm start
```
If you don't have Node installed, you can use [Docker Compose](https://docs.docker.com/compose/):
```sh
# Run the tests
docker-compose run --rm app npm test
```
## Contributing
Third-pary contributions are welcome! 🙏🏼 See [CONTRIBUTING.md](CONTRIBUTING.md) for step-by-step instructions.
If you need help or have a question, let me know via a GitHub issue.
## Deployment
If you want to deploy your own copy of Boomper, follow the [Probot Deployment Guide](https://probot.github.io/docs/deployment/).
## Releasing
Run the following command:
```bash
git checkout master && git pull && npm version [major | minor | patch]
```
The command does the following:
* Ensures you’re on master and don't have local, un-commited changes
* Bumps the version number in [package.json](package.json) based on major, minor or patch
* Runs the `postversion` npm script in [package.json](package.json), which:
* Pushes the tag to GitHub
* Publishes the npm release
* Opens the GitHub releases page so you can publish the release notes