Skip to main content

Extension of Bump2version to push release tag to git remote

Project description

Python 3.9 Lint and Test PyPI version

bump2release

A CLI utility extension of bump2version that will push release tag to git remote in same flow.

Installation

pip install bump2release

Basic Usage

  1. Merge all feature branches to release branch. Either by pull request on remote, or local merge
  2. Run bump2Release (alias b2r), passing SEMVER release type (Major/Minor/Patch), and message for annotated tag

CLI Usage:

usage: bump2release [-h] bump_type tag_message

positional arguments:
  bump_type    Major / Minor / Patch etc.
  tag_message  annotated tag message

optional arguments:
  -h, --help   show this help message and exit

Sample Command

bump2release minor "new feature added"

CLI Output:
B2R Output

Sample Github Result:
Github Result

Command Flow Details

  1. Validate that git staging isn't dirty
  2. Validate that script is running from main/master/dev branch
  3. Pull latest changes from upstream (if feature branch was just merged)
  4. Leverage bump2version to bump version files, commit the change, and create matching annotated tag
  5. Push newly created tag to git remote (which can kick off a publish CI action)

Notes

  • A version.txt file is required
  • Additional files can optionally be specified in .bumpversion.cfg

License

Free Software: MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bump2release-0.2.1.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

bump2release-0.2.1-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file bump2release-0.2.1.tar.gz.

File metadata

  • Download URL: bump2release-0.2.1.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for bump2release-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d819297b1bc398cf3934d9fb09f9f6b5c42232f77fbdeb881a5a780d3f3148c5
MD5 c1ca3cc52ec8057b4f4d78923250ce6d
BLAKE2b-256 3548998c16bfa60cffa4cdcfa56c4619c9ae3be8dbb2ef724e9b9e0a47f238b0

See more details on using hashes here.

File details

Details for the file bump2release-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for bump2release-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f2053f979f5a82e70d6dccf2fc4be24747c2425c0c897e4c38587d43c5ed361
MD5 2209a377b66309b28dc48e6e1da7de1e
BLAKE2b-256 ef31e17abdf4cbe25630a212ac96ab143c047d964ec2f77c9f86207d9ba1e190

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page