{"id":16399788,"url":"https://github.com/justinrubek/bomper","last_synced_at":"2025-08-03T15:41:36.407Z","repository":{"id":50686166,"uuid":"519359687","full_name":"justinrubek/bomper","owner":"justinrubek","description":"automated project releases and changelogs","archived":false,"fork":false,"pushed_at":"2024-10-11T07:20:13.000Z","size":168,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-12T05:25:43.790Z","etag":null,"topics":["cargo-integration","changelog","cli","conventional-commits","flake","git","gitoxide","nix-flake","release","rust","semver"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/justinrubek.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2022-07-29T22:02:16.000Z","updated_at":"2024-05-20T01:11:58.000Z","dependencies_parsed_at":"2024-05-04T21:28:28.503Z","dependency_job_id":"e21491be-c35c-47f8-b3ba-10e312e441a6","html_url":"https://github.com/justinrubek/bomper","commit_stats":{"total_commits":86,"total_committers":3,"mean_commits":"28.666666666666668","dds":0.5930232558139534,"last_synced_commit":"39491c33bdc2cdcfd2c0843e17fbc67f954091a3"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justinrubek%2Fbomper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justinrubek%2Fbomper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justinrubek%2Fbomper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/justinrubek%2Fbomper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/justinrubek","download_url":"https://codeload.github.com/justinrubek/bomper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811380,"owners_count":16884305,"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":["cargo-integration","changelog","cli","conventional-commits","flake","git","gitoxide","nix-flake","release","rust","semver"],"created_at":"2024-10-11T05:25:44.048Z","updated_at":"2024-10-28T09:12:01.242Z","avatar_url":"https://github.com/justinrubek.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bomper\n\n[\u003cimg alt=\"github\" src=\"https://img.shields.io/badge/github-justinrubek/bomper-8da0cb?style=for-the-badge\u0026labelColor=555555\u0026logo=github\" height=\"20\"\u003e](https://github.com/justinrubek/bomper)\n[\u003cimg alt=\"crates.io\" src=\"https://img.shields.io/crates/v/bomper.svg?style=for-the-badge\u0026color=fc8d62\u0026logo=rust\" height=\"20\"\u003e](https://crates.io/crates/bomper)\n[\u003cimg alt=\"docs.rs\" src=\"https://img.shields.io/badge/docs.rs-bomper-66c2a5?style=for-the-badge\u0026labelColor=555555\u0026logo=docs.rs\" height=\"20\"\u003e](https://docs.rs/bomper)\n\n`bomper` is a one-stop shop CLI tool that can update version strings in project files and maintain your project's changelog.\n\n- automatically bump [semver](https://semver.org/) strings in project files\n- changelog generation based on [conventional commits](https://www.conventionalcommits.org/)\n- no system-level dependencies: bomper produces a statically compiled binary thanks to [gitoxide](https://github.com/byron/gitoxide)\n\n## foreword\n\nbomper was originally created to be used as a hook in [cocogitto](https://github.com/cocogitto/cocogitto).\ncocogitto does not update version strings in project files, so bomper was created to fill that gap.\nTheir implementation changelog implementation is more full-featured and configurable than bomper, so\nfor projects that require this flexibility in changelog generation, consider using cocogitto instead.\nYou can still use bomper as a hook without the changelog generation.\n\nbomper aims to be a simpler, more focused, and opinionated tool that can be customized to fit your needs.\n\n## usage\n\nRun `bomp --help` to view the instructions.\n\nIn order for bomper to work, it must be told where to find the files that need to be updated.\nThe configuration supports either arbitrary files or a number of supported project types (currently only `cargo`, but this can be added to).\nThis configuration is specified in a `bomp.ron` file.\nThe file can be in the root-level of the project, in the `${PRJ_CONFIG_HOME}` directory, or specified with the `--config-file` flag.\nSee `./examples` for some specific examples of configuration files.\n\nThere are three main commands: `bump`, `changelog`, and `raw-bump`.\nThe `bump` command will update the version strings in the files specified by the `bomp.ron` file, add changes to the changelog, create a commit, and tag the changes.\nThe `changelog` command will generate and display a changelog based on the commit messages in the repository, but will not update any files.\nThe `raw-bump` command will update the version strings in the files specified by the `bomp.ron` file, but will not add changes to the changelog, commit, or tag the changes.\n\n### flake module\n\nA [flake-parts](https://flake.parts) module is provided to allow integration of bomper without needing to keep a `bomp.ron` file in your project's files.\nIt works by creating a script that wraps the `bomper` command and passes the `bomp.ron` file as an argument.\nThe configuration to use is specified as a nix module option so that it can live inside your nix configuration.\nTo use this you must use `flake-parts`, import the flake module, and specify the options in a `perSystem` block.\nSee [`./flake-parts/bomper.nix`](./flake-parts/bomper.nix) for an example of its usage - this project dogfoods the module.\n\nWith the module enabled, you can access the wrapped bomper package using the `config` parameter of a `perSystem` block: `config.bomper.wrappedBomper`.\n\n## Contributing\n\nThe main dependency for working on this project is nix.\nTo work on this project, first ensure that [Nix: the package manager](https://nixos.org/download.html) is available on your system.\nA `flake.nix` is provided for configuring a development environment.\nTo use this, enter a dev shell: `nix develop`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustinrubek%2Fbomper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjustinrubek%2Fbomper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustinrubek%2Fbomper/lists"}