{"id":13580463,"url":"https://github.com/undergroundwires/bump-everywhere","last_synced_at":"2025-08-15T02:31:20.089Z","repository":{"id":42825976,"uuid":"266632343","full_name":"undergroundwires/bump-everywhere","owner":"undergroundwires","description":"      🚀 Automate versioning, changelog creation, README updates and GitHub releases using GitHub Actions,npm, docker or bash.","archived":false,"fork":false,"pushed_at":"2024-06-16T11:55:46.000Z","size":1539,"stargazers_count":67,"open_issues_count":4,"forks_count":11,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-19T03:24:15.931Z","etag":null,"topics":["changelog","changelog-generator","continuous-delivery","continuous-deployment","continuous-integration","devops","devops-tools","github","github-action","github-actions","gitops","pipeline","versioning"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/undergroundwires.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":"undergroundwires"}},"created_at":"2020-05-24T22:03:40.000Z","updated_at":"2024-09-24T14:31:14.000Z","dependencies_parsed_at":"2024-06-18T22:40:43.836Z","dependency_job_id":"ca2b5bcc-9ce8-4c05-811f-00a0e128d9ce","html_url":"https://github.com/undergroundwires/bump-everywhere","commit_stats":{"total_commits":41,"total_committers":3,"mean_commits":"13.666666666666666","dds":0.3902439024390244,"last_synced_commit":"765134209bfbc7ef8563778dfbca817a9dd090f0"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/undergroundwires%2Fbump-everywhere","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/undergroundwires%2Fbump-everywhere/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/undergroundwires%2Fbump-everywhere/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/undergroundwires%2Fbump-everywhere/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/undergroundwires","download_url":"https://codeload.github.com/undergroundwires/bump-everywhere/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229885866,"owners_count":18139383,"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":["changelog","changelog-generator","continuous-delivery","continuous-deployment","continuous-integration","devops","devops-tools","github","github-action","github-actions","gitops","pipeline","versioning"],"created_at":"2024-08-01T15:01:51.861Z","updated_at":"2024-12-15T23:05:31.878Z","avatar_url":"https://github.com/undergroundwires.png","language":"Shell","funding_links":["https://github.com/sponsors/undergroundwires"],"categories":["Shell"],"sub_categories":[],"readme":"# bump-everywhere\n\n\u003e 🚀 Automate versioning, changelog creation, README updates and GitHub releases using GitHub Actions,npm, docker or bash.\n\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/undergroundwires/bump-everywhere/issues)\n[![Quality checks](https://github.com/undergroundwires/bump-everywhere/workflows/Quality%20checks/badge.svg)](./.github/workflows/quality-checks.yaml)\n[![Bump \u0026 release](https://github.com/undergroundwires/bump-everywhere/workflows/Bump%20\u0026%20release/badge.svg)](./.github/workflows/bump-and-release.yaml)\n[![Publish](https://github.com/undergroundwires/bump-everywhere/workflows/Publish/badge.svg)](./.github/workflows/publish.yaml)\n[![Test](https://github.com/undergroundwires/bump-everywhere/workflows/Test/badge.svg)](./.github/workflows/test.yaml)\n[![Code size](https://img.shields.io/github/languages/code-size/undergroundwires/bump-everywhere)](./scripts)\n[![Docker image size](https://img.shields.io/docker/image-size/undergroundwires/bump-everywhere)](https://hub.docker.com/r/undergroundwires/bump-everywhere)\n[![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere)\n\u003c!-- [![npm](https://img.shields.io/npm/v/bump-everywhere/latest)](https://www.npmjs.com/package/bump-everywhere) --\u003e\n\n![functions of bump-everywhere](./img/functions.png)\n\n## Features\n\n🤖 Allows you to automatically:\n\n- Bump your semantic git tag by increasing the patch version.\n- Create \u0026 commit a changelog file.\n- If `npm` project then bump `package.json` version and commit.\n- Check `README.md` file, if it has references to older version, update with never version.\n- Create a release on GitHub with auto-generated release notes.\n\n✅ Other features include:\n\n- Zero-configuration for most use-cases, but can still be customized.\n- It supports safe re-runs, it means that if you can run it for an already bumped or tagged repository, it'll not increase the version as everything is still up-to-date. It protects against recursive runs.\n\n## Usage\n\n### Option 1. Use GitHub actions\n\n```yaml\n- uses: undergroundwires/bump-everywhere@master\n  with:\n    # Repository name with owner to bump \u0026 release. For example, undergroundwires/bump-everywhere\n    # (Optional) Default: ${{ github.repository  }}\n    repository: ''\n\n    # Name of the user who will do the bump commit\n    # (Optional) Default: ${{ github.actor }}\n    user: ''\n\n    # Commit message that will be used in the bump commit\n    # (Optional) Default: ⬆️ bump everywhere to {{version}}\n    commit-message: ''\n\n    # Personal access token (PAT) used to clone \u0026 push to the repository.\n    # If you use default, it'll not trigger other actions, but your own PAT then it triggers new actions\n    # (Optional) Default: ${{ github.token }}\n    git-token: ''\n\n    # The type of the GitHub release\n    # Options: 'release' | 'prerelease' | 'draft' | 'none' (does not release)\n    # (Optional) Default: 'release'\n    release-type: ''\n\n    # Personal access token (PAT) used to release to GitHub.\n    # Used only if release-type is not \"none\"\n    # If you use default, it'll not trigger other actions, but your own PAT then it triggers new actions\n    # (Optional) Default: ${{ github.token }}\n    release-token: ''\n\n    # Git branch to push the changes such as version tags, CHANGELOG file, version changes...\n    # Configuring this should not be needed for most use-cases.\n    # Use this only if you DO NOT use a single main default branch (e.g. `master` or `main`).\n    # (Optional) Default: Default \"git clone\" behavior. Checks out to default branch of remote.\n    branch: ''\n```\n\n[↑](#bump-everywhere)\n\n### Option 2. Use Docker\n\n- To get the image you can either:\n  - Pull from docker hub using `docker pull undergroundwires/bump-everywhere:latest`\n  - Or build image yourself using `docker build . --tag undergroundwires/bump-everywhere:latest`\n- Run with arguments:\n\n  ```sh\n    args=(\n      # Required:\n      --repository \"undergroundwires/privacy.sexy\"\n      --user \"bot-user\"\n      --git-token \"GitHub PAT for pushes\"\n      --release-type \"prerelease\"\n      --release-token \"GitHub PAT for releases\"\n      --commit-message \"⬆️ bump to {{version}}\"\n      # Optional:\n      --branch 'custom branch name'\n    )\n    docker run undergroundwires/bump-everywhere \"${args[@]}\"\n  ```\n\n[↑](#bump-everywhere)\n\n### Option 3. Use `npm`\n\n1. (Optionally) install globally: `npm install -g bump-everywhere`\n   - or locally: `npm install bump-every-where --save-dev`\n2. Run `npx bump-everywhere \u003cparameters...\u003e`\n   - See [docker example](#option-2-use-docker) for parameter usage\n\n[↑](#bump-everywhere)\n\n### Option 4. Use scripts\n\n1. Ensure `bash` (4 or newer), `git`, `curl`, `jq` exists in your environment\n   - On Alpine: `apk add bash git curl jq`\n   - On Windows: `choco install git curl jq` and use Git Bash\n2. Clone this repository: `git clone https://github.com/undergroundwires/bump-everywhere`\n   - or optionally add this repository as git submodule: `git submodule add https://github.com/undergroundwires/bump-everywhere`\n3. Call the script: `bash \"scripts/bump-everywhere.sh\" \u003cparameters\u003e`\n   - See [docker example](#option-2-use-docker) for parameter usage\n\n[↑](#bump-everywhere)\n\n## Updating minor \u0026 major versions\n\nbump-everywhere only increases your patch versions. You manually tag your last commit to update major \u0026 minor versions.\n\nE.g. :\n\n```sh\n  git commit -m \"bumped version to 1.4.0\" --allow-empty\n  git tag 1.4.0\n  git push \u0026\u0026 git push origin 1.4.0\n```\n\n[↑](#bump-everywhere)\n\n## All scripts\n\nYou can also use following scripts individually (check script files for usage, prerequisites \u0026 dependencies):\n\n- **[bump-and-tag-version.sh](./scripts/bump-and-tag-version.sh)**: Automate versioning.\n- **[create-github-release.sh](./scripts/create-github-release.sh)**: Automate creating GitHub releases\n- **[print-changelog.sh](./scripts/print-changelog.sh)**: Automate creation of changelogs, e.g. `CHANGELOG.md`.\n- **[configure-github-repo.sh](./scripts/configure-github-repo.sh)**: Set-up CI/CD user for current repository.\n- **[log-commits.sh](./scripts/shared/log-commits.sh)**: Filters \u0026 logs commits as bullet points in markdown form.\n- **[bump-npm-version.sh](./scripts/bump-npm-version.sh)**: Updates `packages.json` to match the latest version.\n- **[bump-readme-versions.sh](./scripts/bump-readme-versions.sh)**: Updates old references to `README.md` to the latest version.\n\n[↑](#bump-everywhere)\n\n## Some example usages\n\n- [bump-everywhere](https://github.com/undergroundwires/bump-everywhere#gitops): Repository itself is automatically versioned \u0026 released using its own action\n- [privacy.sexy](https://github.com/undergroundwires/privacy.sexy#gitops-cicd-to-aws)\n- [safe-email](https://github.com/undergroundwires/safe-email#gitops)\n- [ez-consent](https://github.com/undergroundwires/ez-consent#gitops)\n- [aws-static-site-with-cd](https://github.com/undergroundwires/aws-static-site-with-cd)\n\n[↑](#bump-everywhere)\n\n## Support\n\n**Sponsor 💕**. Consider one time or recurring donation on [GitHub Sponsors](https://github.com/sponsors/undergroundwires) or [any other way (undrgroundwires.dev/donate)](https://undergroundwires.dev/donate), every penny you leave will help development and maintenance of the project .\n\n**Star 🤩**. If you do cannot do that you can just give it a star ⭐ . It helps me to see that the project is appreciated.\n\n**Badge 📛**. If you use the project, feel free to use the badge in the `README.md` of repository where you use bump-everywhere so we can have larger community that can help improving the project. It would look like [![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere)). You can add following in your markdown file:\n\n```markdown\n[![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere)\n```\n\n[↑](#bump-everywhere)\n\n## GitOps\n\nCI/CD is fully automated for this repo using different GIT events and GitHub actions.\n\n[![GitOps flow](./img/gitops.png)](./.github/workflows)\n\n[↑](#bump-everywhere)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fundergroundwires%2Fbump-everywhere","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fundergroundwires%2Fbump-everywhere","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fundergroundwires%2Fbump-everywhere/lists"}