toolmantim / Boomper
Licence: isc
Bump version numbers in files whenever new releases are published to GitHub.
Stars: ✭ 33
Programming Languages
javascript
184084 projects - #8 most used programming language
Labels
Projects that are alternatives of or similar to Boomper
Mergeable
🤖 All the missing GitHub automation 🙂 🙌
Stars: ✭ 475 (+1339.39%)
Mutual labels: github-app, probot-app
triage-new-issues
A GitHub App, built with Probot that adds `triage` label to newly-created issues which don't have labels
Stars: ✭ 23 (-30.3%)
Mutual labels: github-app, probot-app
branch-switcher
a GitHub bot that switches the base branch of pull requests to the preferred branch
Stars: ✭ 15 (-54.55%)
Mutual labels: github-app, probot-app
Probot Gpg
A GitHub App that enforces GPG signatures on pull requests (no longer maintained)
Stars: ✭ 13 (-60.61%)
Mutual labels: github-app, probot-app
issuelabeler
A GitHub bot to label issues automatically based on title and body against list of defined labels. System status (https://status.verticalaxisbd.com/)
Stars: ✭ 23 (-30.3%)
Mutual labels: github-app, probot-app
boring-cyborg
🤖 A Github bot to automatically label PRs, issues and perform all the boring operations that you don't want to do.
Stars: ✭ 66 (+100%)
Mutual labels: github-app, probot-app
Weekly Digest
Weekly summary of activity on your GitHub repository 📆
Stars: ✭ 199 (+503.03%)
Mutual labels: github-app, probot-app
github-task-list-completed
GitHub - Task list completed PR check
Stars: ✭ 95 (+187.88%)
Mutual labels: github-app, probot-app
app
GitHub App that enforces the Developer Certificate of Origin (DCO) on Pull Requests
Stars: ✭ 236 (+615.15%)
Mutual labels: github-app, probot-app
new-pr-welcome
Welcome users when they open their first PR in your repository
Stars: ✭ 20 (-39.39%)
Mutual labels: github-app, probot-app
Settings
Pull Requests for GitHub repository settings
Stars: ✭ 514 (+1457.58%)
Mutual labels: github-app, probot-app
yamburger
YAML syntax got you down? That's a YAMBURGER!
Stars: ✭ 32 (-3.03%)
Mutual labels: github-app, probot-app
linter-alex
📝Sensitive, considerate writing before you merge your Pull Requests
Stars: ✭ 67 (+103.03%)
Mutual labels: github-app, probot-app
scalafmt-probot
🤖Github bot for checking code formatting with scalafmt
Stars: ✭ 15 (-54.55%)
Mutual labels: github-app, probot-app
react-preview
a GitHub App built with probot that generates preview links for react based projects.
Stars: ✭ 14 (-57.58%)
Mutual labels: github-app, probot-app
Gh Polls Bot
Automatically create polls in GitHub issues.
Stars: ✭ 187 (+466.67%)
Mutual labels: github-app, probot-app
Dco
GitHub App that enforces the Developer Certificate of Origin (DCO) on Pull Requests
Stars: ✭ 188 (+469.7%)
Mutual labels: github-app, probot-app
merge-me
A GitHub app that merges your pull requests once all required checks pass.
Stars: ✭ 19 (-42.42%)
Mutual labels: github-app, probot-app
Todo
🤖✅ GitHub App that creates new issues from actionable comments in your code.
Stars: ✭ 685 (+1975.76%)
Mutual labels: github-app, probot-app
Bump version numbers in files whenever new releases are published to GitHub. 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`
Examples
Buildkite Plugin Readmes
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:
# 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:
# Run the tests
docker-compose run --rm app npm test
Contributing
Third-pary contributions are welcome! 🙏🏼 See 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.
Releasing
Run the following command:
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 based on major, minor or patch
- Runs the
postversionnpm script in package.json, which:- Pushes the tag to GitHub
- Publishes the npm release
- Opens the GitHub releases page so you can publish the release notes
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].