BUMPVERSION(1)

πŸ“¦
version 1.0.1 Β· 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

✨ NAME ✨

bumpversion β€” version-bump your software, bestie πŸ’– (it's the manual page, and it's serving)


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so real talk, this is literally the usage of bumpversion, here's the whole thing:

bumpversion [-h] [--config-file FILE] [--verbose] [--list]
       [--allow-dirty] [--parse REGEX] [--serialize FORMAT] [--search
       SEARCH] [--replace REPLACE] [--current-version VERSION]
       [--no-configured-files] [--dry-run] --new-version VERSION
       [--commit | --no-commit] [--tag | --no-tag] [--sign-tags |
       --no-sign-tags] [--tag-name TAG_NAME] [--tag-message TAG_MESSAGE]
       [--message COMMIT_MSG] [--commit-args COMMIT_ARGS] part [file
       ...]

and the version check moment:

bumpversion: v1.0.1 (using Python v3.9.7)

πŸŽ€ POSITIONAL ARGUMENTS πŸŽ€

  • part β€” which lil slice of the version is getting bumped. that's the whole assignment. πŸ‘‘
  • file β€” the files you wanna change (default: []) πŸ“‚

πŸ’… OPTIONAL ARGUMENTS πŸ’…

  • -h, --help β€” shows this help message and dips. classic. (default behavior: shows help and exits) ✨
  • --config-file FILE β€” the config file it reads most of the variables from (default: .bumpversion.cfg) πŸ“
  • --verbose β€” prints verbose logging to stderr (default: 0) β€” turn it up, get the tea πŸ«–
  • --list β€” list machine readable information (default: False) πŸ€–
  • --allow-dirty β€” don't abort if the working directory is dirty (default: False) β€” chaotic energy, respect 🫢
  • --parse REGEX β€” the regex that parses the version string (default: (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z ]+))?)) πŸ”
  • --serialize FORMAT β€” how to format what's parsed back into a version (default: ['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}']) 🧚
  • --search SEARCH β€” template for the complete string to search (default: {current_version}) πŸ”Ž
  • --replace REPLACE β€” template for the complete string to replace (default: {new_version}) πŸ”
  • --current-version VERSION β€” the version that needs to be updated (default: 1.0.1) πŸ“Œ
  • --no-configured-files β€” only replace the version in files specified on the command line, ignoring the files from the configuration file (default: False) πŸ™ˆ
  • --dry-run, -n β€” don't write any files, just pretend. (default: False) β€” manifesting only, no cap ✨
  • --new-version VERSION β€” the new version that should be in the files (default: None) 🌟
  • --commit β€” commit to version control (default: True) πŸ’Ύ
  • --no-commit β€” do not commit to version control 🚫
  • --tag β€” create a tag in version control (default: True) 🏷️
  • --no-tag β€” do not create a tag in version control 🚫
  • --sign-tags β€” sign tags if created (default: False) ✍️
  • --no-sign-tags β€” do not sign tags if created 🚫
  • --tag-name TAG_NAME β€” tag name (only works with --tag) (default: v{new_version}) 🏷️✨
  • --tag-message TAG_MESSAGE β€” tag message (default: Bump version: {current_version} ??? {new_version}) πŸ’¬
  • --message COMMIT_MSG, -m COMMIT_MSG β€” commit message (default: Bump version: {current_version} ??? {new_version}) πŸ’¬
  • --commit-args COMMIT_ARGS β€” extra arguments to commit command (default: ``) βž•
ngl bestie, if you're doing a --dry-run first, you're the main character. periodt. πŸ’…

🌈 SEE ALSO 🌈

The full documentation for bumpversion is maintained as a Texinfo manual. If the info and bumpversion programs are properly installed at your site, the command

info bumpversion

should give you access to the complete manual. πŸ‘‘


that's the whole vibe check, babe πŸ’– bumpversion 1.0.1, November 2021, BUMPVERSION(1) β€” ok bye love u, go bump responsibly πŸŽ€πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from