diff --git a/docs/index.html b/docs/index.html index 2f3a363..5e17502 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,529 +1,545 @@ -
- Bump is a lightweight command-line tool that helps you - manage semantic versioning tags in Git repositories. It - automates version increments following SemVer standards, - making it easy to maintain proper versioning in your - projects. -
Semantic versioning for Git, simplified.
A lightweight CLI tool that automates version increments following SemVer standards. Manage your project versions with confidence.
$ bump -• on default branch: main -• no uncommitted changes -• no remote changes -• no unpushed changes -• no new remote tags -• bump tag v1.2.3 => v1.2.4 -• tag v1.2.4 created -• tag v1.2.4 pushed
brew tap flaticols/apps +brew install flaticols/apps/bump
brew tap flaticols/apps -brew install flaticols/apps/bump
go install github.com/flaticols/bump@latest
Bump follows semantic versioning principles, allowing you to easily increment major, minor, or patch versions.
bump
Bumps patch version
1.2.3 → 1.2.4
bump major
Bumps major version
1.2.3 → 2.0.0
bump minor
Bumps minor version
1.2.3 → 1.3.0
bump patch
bump undo
Removes the last version tag
v1.2.4 → v1.2.3
--repo, -r
--verbose, -v
--local, -l
--brave, -b
--no-color
--version
- Bump follows semantic versioning principles, allowing you to - easily increment the major, minor, or patch version of your - project. -
bump # Bumps patch version (e.g., 1.2.3 -> 1.2.4) -bump major # Bumps major version (e.g., 1.2.3 -> 2.0.0) -bump minor # Bumps minor version (e.g., 1.2.3 -> 1.3.0) -bump patch # Bumps patch version (e.g., 1.2.3 -> 1.2.4) -bump undo # Removes the last version tag
--repo, -r Path to the repository (if not current directory) ---verbose, -v Print verbose output ---local, -l If local is set, bump will not error if no remotes are found ---brave, -b If brave is set, bump will not ask any questions (default: false) ---no-color Disable colorful output (default: false) ---version Print version information
Bump includes the following commands:
bump [major|minor|patch] # Main command to increment version (defaults to patch) -bump undo # Removes the most recently created version tag
- Automatically detects and increments from the latest - git tag. -
Automatically detects and increments from the latest git tag
- Validates that you're on a default branch (main, - master, etc.). -
Validates you're on a default branch (main, master, etc.)
- Checks for uncommitted local changes and remote - synchronization. -
Checks for uncommitted changes and remote synchronization
- Creates and pushes git tags using semantic - versioning. -
Creates and pushes git tags using semantic versioning
- Easily remove the most recent version tag when - needed. -
Easily remove the most recent version tag when needed
- Provides visually appealing and clear terminal - feedback with status indicators. -
Visually appealing terminal feedback with status indicators
- Automatically detects and fetches new tags from - remote before performing operations. -
Automatically detects and fetches new tags from remote
- Bypass warnings and continue operations with the - brave flag for advanced users. -
Bypass warnings and continue operations for advanced users
- Increment the patch version number: -
- Increment the major version for breaking changes: -
$ bump major -• on default branch: main -• no uncommitted changes -• no remote changes -• no unpushed changes -• no new remote tags -• bump tag v1.2.3 => v2.0.0 -• tag v2.0.0 created -• tag v2.0.0 pushed
- Increment the minor version for new features: -
$ bump minor -• on default branch: main -• no uncommitted changes -• no remote changes -• no unpushed changes -• no new remote tags -• bump tag v1.2.3 => v1.3.0 -• tag v1.3.0 created -• tag v1.3.0 pushed
- Specify a different repository path: -
$ bump --repo=/path/to/repo minor -• working directory: /path/to/repo -• on default branch: main -• no uncommitted changes -• no remote changes -• no unpushed changes -• no new remote tags -• bump tag v1.2.3 => v1.3.0 -• tag v1.3.0 created -• tag v1.3.0 pushed
- Remove the most recently created version tag: -
$ bump undo -Are you sure? [Y/n] Y -• removing tag v1.2.4 -• local tag removed -• remote tag removed
- Skip all confirmation prompts with brave mode: -
$ bump undo --brave -• brave mode enabled, ignoring warnings and errors -• removing tag v1.2.4 -• local tag removed -• remote tag removed
- Work with a repository without remotes: -
$ bump --local -• on default branch: main -• no uncommitted changes -• no unpushed changes -• bump tag v1.2.3 => v1.2.4 -• tag v1.2.4 created
- Automatically fetch new tags from remote: -
$ bump -• on default branch: main -• no uncommitted changes -• no remote changes -• no unpushed changes -• remote has new tags, fetching tags first -• tags fetched successfully -• bump tag v1.2.3 => v1.2.4 -• tag v1.2.4 created -• tag v1.2.4 pushed
- Track the development progress of Bump. For a full - changelog, visit - CHANGELOG.md - on GitHub. -
Increment the patch version number
$ bump +● on default branch: main +● no uncommitted changes +● no remote changes +● no unpushed changes +● no new remote tags +● bump tag v1.2.3 → v1.2.4 +● tag v1.2.4 created +● tag v1.2.4 pushed
major
minor
patch
Increment the major version for breaking changes
$ bump major +● on default branch: main +● no uncommitted changes +● no remote changes +● no unpushed changes +● no new remote tags +● bump tag v1.2.3 → v2.0.0 +● tag v2.0.0 created +● tag v2.0.0 pushed
HasRemoteUnfetchedTags()
--brave
-b
Specify a different repository path
$ bump --repo=/path/to/repo minor +● working directory: /path/to/repo +● on default branch: main +● no uncommitted changes +● no remote changes +● no unpushed changes +● no new remote tags +● bump tag v1.2.3 → v1.3.0 +● tag v1.3.0 created +● tag v1.3.0 pushed
Skip all confirmation prompts with brave mode
$ bump undo --brave +● brave mode enabled +● removing tag v1.2.4 +● local tag removed +● remote tag removed