https://github.com/alirezatheh/auto-bump-versions

GitHub action to automate bump version in CHANGELOG.md (Keep a Changelog format) and optionally bump other files’ version using BumpVer, then commit and push changes.
https://github.com/alirezatheh/auto-bump-versions

actions github github-actions semantic-versioning version version-control versioning

Last synced: about 1 month ago
JSON representation

GitHub action to automate bump version in CHANGELOG.md (Keep a Changelog format) and optionally bump other files’ version using BumpVer, then commit and push changes.

• Host: GitHub
• URL: https://github.com/alirezatheh/auto-bump-versions
• Owner: AlirezaTheH
• License: mit
• Created: 2022-05-28T08:39:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-05T13:11:32.000Z (over 1 year ago)
• Last Synced: 2024-09-17T01:50:27.983Z (2 months ago)
• Topics: actions, github, github-actions, semantic-versioning, version, version-control, versioning
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Auto Bump Versions

GitHub action to automate bump version in `CHANGELOG.md`

([Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format) and

optionally bump other files' version using

[BumpVer](https://github.com/mbarkhau/bumpver), then commit and push changes.

## Usage

```yaml

name: Publish

on:

  push:

    branches:

      - main

  workflow_dispatch:

jobs:

  bump-versions:

    runs-on: ubuntu-latest

    steps:

      - uses: alirezatheh/auto-bump-versions@v1

        with:

          github-token: ${{ secrets.GITHUB_TOKEN }}

          new-version: 1.2.3

          use-bumpver: true

```

The action assume:

- Python and pip are installed (e.g. by `actions/setup-python@v3`).

## Inputs

- `github-token`: GitHub token (required).

- `new-version`: The version to be bumped. If missing guess the new version

  using section names in unreleased changes of `CHANGELOG.md`

  ([Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format) (optional).

- `use-bumpver`: If use `BumpVer` to bump local version in files other than

  `CHANGELOG.md`. If this is `true` your project root must contain

  `bumpver.toml` file, Defaults to `false` (optional).

## Outputs

- `new-version`: New version to be released. If `new-version` input is missing,

  this is the guessed version.

## Acknowledgements

This action is inspired by

[pypi-auto-publish](https://github.com/etils-actions/pypi-auto-publish)