KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

boomper

★ 38 Open GitHub ↗

Bump version numbers in files whenever new releases are published to GitHub.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">Bump version numbers in files whenever new releases are published to GitHub. Built with <a href="https://github.com/probot/probot">Probot</a>.</p>

---

---

[![NPM package](https://img.shields.io/npm/v/boomper-github-app.svg)](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:

## 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

boomper

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README