{"id":15511808,"url":"https://github.com/toolmantim/boomper","last_synced_at":"2025-06-17T23:36:02.104Z","repository":{"id":32713741,"uuid":"138401499","full_name":"toolmantim/boomper","owner":"toolmantim","description":"Bump version numbers in files whenever new releases are published to GitHub.","archived":false,"fork":false,"pushed_at":"2025-06-10T03:31:14.000Z","size":1256,"stargazers_count":38,"open_issues_count":33,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-10T04:28:32.492Z","etag":null,"topics":["github-app","probot-app"],"latest_commit_sha":null,"homepage":"https://github.com/apps/boomper-bot","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toolmantim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-06-23T13:03:35.000Z","updated_at":"2023-09-08T15:10:36.000Z","dependencies_parsed_at":"2023-11-18T01:59:49.483Z","dependency_job_id":"6b501c60-b4c5-46ff-b429-405a078b15bd","html_url":"https://github.com/toolmantim/boomper","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/toolmantim/boomper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolmantim%2Fboomper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolmantim%2Fboomper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolmantim%2Fboomper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolmantim%2Fboomper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toolmantim","download_url":"https://codeload.github.com/toolmantim/boomper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolmantim%2Fboomper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260458429,"owners_count":23012494,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-app","probot-app"],"created_at":"2024-10-02T09:53:14.291Z","updated_at":"2025-06-17T23:35:57.092Z","avatar_url":"https://github.com/toolmantim.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"design/logo.svg\" alt=\"Boomper Logo\" width=\"350\" /\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eBump version numbers in files whenever new releases are published to GitHub. Built with \u003ca href=\"https://github.com/probot/probot\"\u003eProbot\u003c/a\u003e.\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/apps/boomper-bot\"\u003e\u003cimg src=\"design/install-button.svg\" alt=\"Install the GitHub App\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n---\n\n[![NPM package](https://img.shields.io/npm/v/boomper-github-app.svg)](https://www.npmjs.com/package/boomper-github-app)\n\n## Usage\n\nFirstly, 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.\n\nThen, add a `.github/boomper.yml` configuration file to the GitHub repository where you publish new releases to.\n\nFor example, given the following `.github/boomper.yml` file:\n\n```yml\nupdates:\n- path: README.md\n  pattern: 'https://someurl.com/(v.*)/download.zip'\n```\n\nAnd given the following `README.md` file:\n\n```markdown\nInstall with `curl https://someurl.com/v1.0.0/download.zip`\n```\n\nThen when a new release is published (e.g. `v2.0.0`), Boomper will update the `README.md` to:\n\n```markdown\nInstall with `curl https://someurl.com/v2.0.0/download.zip`\n```\n\n## Examples\n\n### [Buildkite Plugin Readmes](https://buildkite.com/docs/agent/v3/plugins)\n\n```yml\nupdates:\n- path: README.md\n  pattern: 'my-org/my-plugin#(v.*):'\n```\n\n## Configuration options\n\nYou can configure Boomper using the following key in your `.github/boomper.yml` file:\n\n|Key|Required|Description|\n|-|-|-|\n|`updates`|Required|A list of paths and patterns to update when a new release is published.|\n|`updates.[].path`|Required|The path to the file to update.|\n|`updates.[].pattern`|Required|The regular expression containing a single group, which will be used to match and update the version number in the file.|\n|`updates.[].branch`|Optional|The branch to update. Default is the repository's default branch (e.g. `master`).|\n|`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\"`.|\n|`skip-ci`|Optional|Appends `[ci skip]` to commit messages to prevent triggering additional CI builds. Default is `false`.|\n\n## Developing\n\nIf you have Node v10+ installed locally, you can run the tests, and a local app, using the following commands:\n\n```sh\n# Install dependencies\nyarn\n\n# Run the tests\nnpm test\n\n# Run the app locally\nnpm start\n```\n\nIf you don't have Node installed, you can use [Docker Compose](https://docs.docker.com/compose/):\n\n```sh\n# Run the tests\ndocker-compose run --rm app npm test\n```\n\n## Contributing\n\nThird-pary contributions are welcome! 🙏🏼 See [CONTRIBUTING.md](CONTRIBUTING.md) for step-by-step instructions.\n\nIf you need help or have a question, let me know via a GitHub issue.\n\n## Deployment\n\nIf you want to deploy your own copy of Boomper, follow the [Probot Deployment Guide](https://probot.github.io/docs/deployment/).\n\n## Releasing\n\nRun the following command:\n\n```bash\ngit checkout master \u0026\u0026 git pull \u0026\u0026 npm version [major | minor | patch]\n```\n\nThe command does the following:\n\n* Ensures you’re on master and don't have local, un-commited changes\n* Bumps the version number in [package.json](package.json) based on major, minor or patch\n* Runs the `postversion` npm script in [package.json](package.json), which:\n  * Pushes the tag to GitHub\n  * Publishes the npm release\n  * Opens the GitHub releases page so you can publish the release notes","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolmantim%2Fboomper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoolmantim%2Fboomper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolmantim%2Fboomper/lists"}