git-flow-next

https://git-flow.sh/docs/
Admin
git-flow-next is a modern reimplementation of the git-flow branching model written in Go, offering...
Tokens:9,419
Snippets:120
Trust Score:6.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start topic branch examples

Source: https://git-flow.sh/docs/commands

Examples for starting feature and release branches.

```bash
# Start a new feature
git flow feature start user-authentication

# Start a release
git flow release start 1.2.0
```

--------------------------------

### git-flow init usage examples

Source: https://git-flow.sh/docs/commands

Various ways to initialize git-flow, including presets, defaults, and custom configurations.

```bash
# Interactive initialization
git flow init

# Initialize with Classic GitFlow preset
git flow init --preset=classic

# Initialize with defaults without prompting
git flow init --defaults

# Initialize with preset and defaults
git flow init --preset=classic --defaults

# Custom configuration mode
git flow init --custom

# GitHub Flow with custom main branch
git flow init --preset=github --main=master

# Initialize with short flags
git flow init -p classic -d -m master -b bug/ -r rel/

# Force reconfiguration
git flow init --force --feature=feat/

# Initialize with global scope (user-wide defaults)
git flow init --defaults --global

# Initialize with configuration file
git flow init --defaults --file=/path/to/custom-gitflow.config
```

--------------------------------

### Manage git-flow configuration examples

Source: https://git-flow.sh/docs/commands

Common operations for listing, adding, editing, and renaming base and topic branches.

```bash
# List current configuration
git flow config list

# Add production trunk branch
git flow config add base production

# Add staging branch that auto-updates from production
git flow config add base staging production --auto-update=true

# Add feature branch type with custom prefix
git flow config add topic feature develop --prefix=feat/

# Add release branch type with tagging
git flow config add topic release main --starting-point=develop --tag=true

# Add bugfix branch type with squash merging
git flow config add topic bugfix develop --upstream-strategy=squash --prefix=bug/

# Edit feature branches to use rebase when finishing
git flow config edit topic feature --upstream-strategy=rebase

# Rename develop branch to integration
git flow config rename base develop integration
```

--------------------------------

### Start a new topic branch

Source: https://git-flow.sh/docs/commands

Syntax for creating and checking out a new topic branch.

```bash
git-flow <topic> start <name> [base] [options]
```

--------------------------------

### Install git-flow-next with Homebrew

Source: https://git-flow.sh/docs/installation

Use this command to install git-flow-next on macOS if you have Homebrew installed. This is the recommended installation method for Mac users.

```bash
brew install git-flow-next
```

--------------------------------

### Release Start Version Filter

Source: https://git-flow.sh/docs/configuration

A filter script to enforce semantic versioning for release starts. Outputs the validated version to stdout.

```shell
#!/bin/sh
# .git/hooks/filter-flow-release-start-version
# Enforce semantic versioning
VERSION="$1"
if ! echo "$VERSION" | grep -qE '^v?[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.]+)?$'; then
    echo "Error: Version must follow semantic versioning (e.g., 1.0.0)" >&2
    exit 1
fi
echo "$VERSION"
```

--------------------------------

### Pre-flow Release Start Hook

Source: https://git-flow.sh/docs/configuration

A pre-hook script to verify CI status before starting a release. Exits with status 1 to block the operation if CI is not successful.

```shell
#!/bin/sh
# .git/hooks/pre-flow-release-start
# Verify CI is passing before release
if command -v gh &> /dev/null; then
    STATUS=$(gh run list --branch "${BASE_BRANCH:-develop}" --limit 1 --json conclusion -q '.[0].conclusion')
    if [ "$STATUS" != "success" ]; then
        echo "Error: CI is not passing on ${BASE_BRANCH:-develop}"
        exit 1
    fi
fi
exit 0
```

--------------------------------

### Start a new feature branch

Source: https://git-flow.sh/docs/installation

Use this command to begin work on a new feature. Replace 'my-feature' with the actual name of your feature.

```bash
git flow feature start my-feature
```

--------------------------------

### Command-Specific Overrides

Source: https://git-flow.sh/docs/configuration

Configures behavior for specific Git-Flow commands like start, finish, and publish.

```bash
# Always fetch before starting features
git config gitflow.feature.start.fetch true

# Always use rebase strategy for feature finish
git config gitflow.feature.finish.rebase true

# Squash commits when finishing hotfixes
git config gitflow.hotfix.finish.squash true

# Sign release tags
git config gitflow.release.finish.sign true
git config gitflow.release.finish.signingkey ABC123DEF

# Keep support branches after finishing
git config gitflow.support.finish.keep true

# Custom merge message (supports placeholders)
git config gitflow.feature.finish.mergemessage "feat: merge %b into %p"

# Custom update message for child branches
git config gitflow.release.finish.updatemessage "chore: sync %b from %p"

# Bypass hooks during finish
git config gitflow.feature.finish.noverify true

# Fetch before finishing (enabled by default)
git config gitflow.feature.finish.fetch true

# Push options for publish command
git config gitflow.feature.publish.push-option "ci.skip"

# Multiple push options (use --add for additional values)
git config gitflow.release.publish.push-option "merge_request.create"
git config --add gitflow.release.publish.push-option "merge_request.target=main"
```

--------------------------------

### Start Git Flow branches

Source: https://git-flow.sh/docs/commands

Commands to initiate new feature or hotfix branches from specific commits or tags.

```bash
git flow feature start emergency-fix abc123def

git flow feature start new-api --fetch

git flow hotfix start 1.1.1 v1.1.0
```

--------------------------------

### Finish Git Flow branches

Source: https://git-flow.sh/docs/commands

Examples of finishing features, releases, and hotfixes with various configuration options like signing, rebasing, and custom messaging.

```bash
# Finish current branch (shorthand)
git flow finish

# Finish specific feature
git flow feature finish user-authentication

# Finish release with signed tag
git flow release finish 1.2.0 --tag --sign

# Handle conflicts
git flow feature finish my-feature
# ... resolve conflicts ...
git flow feature finish my-feature --continue

# Force rebase strategy
git flow feature finish my-feature --rebase

# Squash all commits with custom message
git flow feature finish my-feature --squash --squash-message "feat: add user authentication"

# Custom merge message with placeholders
git flow feature finish my-feature --merge-message "feat: merge %b into %p"

# Custom messages for both merge and child updates
git flow release finish 1.2.0 \
  --merge-message "release: version 1.2.0" \
  --update-message "chore: sync %b from %p"

# Skip hooks during finish
git flow feature finish my-feature --no-verify

# Keep branch after finishing
git flow hotfix finish 1.1.1 --keep
```

--------------------------------

### Checkout Topic Branch with Partial Matching

Source: https://git-flow.sh/docs/commands

Switch to a topic branch. Supports partial name matching, where if an exact match isn't found, it looks for branches starting with the provided prefix. Multiple matches will result in an error.

```bash
git-flow <topic> checkout <name|prefix>
```

```bash
# Checkout specific feature
git flow feature checkout user-auth
```

```bash
# Partial match checkout
git flow feature checkout user
```

```bash
# Checkout a release
git flow release checkout 1.2.0
```

--------------------------------

### Track Remote Topic Branch

Source: https://git-flow.sh/docs/commands

Create a local branch that tracks a remote topic branch. This is useful for collaborating on branches initiated by other team members. The example illustrates a common team workflow.

```bash
git-flow <topic> track <name>
```

```bash
# Track a remote feature branch
git flow feature track user-authentication
```

```bash
# Track a remote release
git flow release track 1.0.0
```

```bash
# Team workflow
# Developer A publishes:
git flow feature publish shared-feature
# Developer B tracks:
git flow feature track shared-feature
```

--------------------------------

### Initialize Classic GitFlow

Source: https://git-flow.sh/docs/configuration

Sets up the classic GitFlow workflow using a preset or manual configuration.

```bash
# Initialize with preset
git flow init --preset=classic

# Or configure manually
git flow config add base main
git flow config add base develop main --auto-update=true
git flow config add topic feature develop --prefix=feature/
git flow config add topic release main --starting-point=develop --tag=true
git flow config add topic hotfix main --prefix=hotfix/ --tag=true
git flow config add topic support main --prefix=support/
```

--------------------------------

### Initialize GitHub Flow

Source: https://git-flow.sh/docs/configuration

Sets up the GitHub Flow workflow using a preset or manual configuration.

```bash
# Initialize with preset
git flow init --preset=github

# Or configure manually
git flow config add base main
git flow config add topic feature main --prefix=feature/
```

--------------------------------

### Initialize git-flow configuration

Source: https://git-flow.sh/docs/commands

The base command for setting up git-flow in a repository.

```bash
git-flow init [-f|--force] [--preset=preset] [--custom] [--defaults] [--local|--global|--system|--file=path] [options]
```

--------------------------------

### Display repository overview

Source: https://git-flow.sh/docs/commands

Syntax for displaying the current repository's git-flow configuration and status.

```bash
git-flow overview [--format=format] [--verbose] [--no-color]
```

--------------------------------

### Initialize GitLab Flow

Source: https://git-flow.sh/docs/configuration

Sets up the GitLab Flow workflow using a preset or manual configuration.

```bash
# Initialize with preset
git flow init --preset=gitlab

# Or configure manually
git flow config add base production
git flow config add base staging production --auto-update=true
git flow config add base main staging --auto-update=true
git flow config add topic feature main --prefix=feature/
git flow config add topic hotfix production --prefix=hotfix/ --tag=true
```

--------------------------------

### Initialize git-flow with different scopes

Source: https://git-flow.sh/docs/configuration

Use these commands to initialize git-flow-next with specific configuration storage locations.

```bash
# Set team defaults globally
git flow init --defaults --global

# Override specific settings in a repository
git flow init --defaults --local

# Shared configuration file
git flow init --defaults --file=/shared/team-gitflow.config
```

--------------------------------

### Output overview as JSON

Source: https://git-flow.sh/docs/commands

Generate structured JSON output for CI/CD or tooling integration.

```bash
git flow overview --format=json
```

--------------------------------

### Initialize git-flow in a repository

Source: https://git-flow.sh/docs/installation

Run this command in your project's root directory to initialize git-flow. This sets up the necessary branching structure for your repository.

```bash
git flow init
```

--------------------------------

### Display git-flow-next help information

Source: https://git-flow.sh/docs/installation

Access the full list of available commands and options for git-flow-next by running this command. It provides comprehensive usage details.

```bash
git-flow-next --help
```

--------------------------------

### checkout

Source: https://git-flow.sh/docs/commands

Switch to a topic branch with support for partial name matching.

```APIDOC
## checkout

### Description
Switch to a topic branch with support for partial name matching. If no exact match is found, it looks for branches starting with the given prefix.

### Usage
git-flow <topic> checkout <name|prefix>
```

--------------------------------

### Check version information

Source: https://git-flow.sh/docs/commands

Display the current version of git-flow-next.

```bash
git-flow version
```

--------------------------------

### Configure git-flow branches

Source: https://git-flow.sh/docs/commands

General syntax for managing git-flow configuration.

```bash
git-flow config <command> [args] [options]
```

--------------------------------

### Branch Type Configuration Keys

Source: https://git-flow.sh/docs/configuration

Defines default branch behavior and command-specific overrides using configuration keys.

```bash
git config gitflow.branch.<type>.prefix <prefix>
git config gitflow.branch.<type>.parent <parent-branch>
git config gitflow.branch.<type>.startpoint <start-branch>
git config gitflow.branch.<type>.upstreamstrategy <merge|rebase|squash>
git config gitflow.branch.<type>.downstreamstrategy <merge|rebase>
git config gitflow.branch.<type>.tag <true|false>
git config gitflow.branch.<type>.tagprefix <prefix>
git config gitflow.branch.<type>.autoupdate <true|false>
git config gitflow.branch.<type>.forcedelete <true|false>
```

```bash
# Start command overrides
git config gitflow.<type>.start.fetch <true|false>

# Finish command overrides
git config gitflow.<type>.finish.rebase <true|false>
git config gitflow.<type>.finish.squash <true|false>
git config gitflow.<type>.finish.preserve-merges <true|false>
git config gitflow.<type>.finish.no-ff <true|false>
git config gitflow.<type>.finish.tag <true|false>
git config gitflow.<type>.finish.notag <true|false>
git config gitflow.<type>.finish.sign <true|false>
git config gitflow.<type>.finish.signingkey <keyid>
git config gitflow.<type>.finish.keep <true|false>
git config gitflow.<type>.finish.force-delete <true|false>
git config gitflow.<type>.finish.fetch <true|false>
git config gitflow.<type>.finish.noverify <true|false>
git config gitflow.<type>.finish.mergemessage <message>
git config gitflow.<type>.finish.updatemessage <message>

# Publish command overrides
git config gitflow.<type>.publish.push-option <option>
```

--------------------------------

### Configure Custom Hooks Directory

Source: https://git-flow.sh/docs/configuration

Commands to set up a custom directory for git-flow hooks, either specifically for git-flow or globally for all Git hooks.

```shell
# Recommended: use gitflow.path.hooks (only affects git-flow hooks)
mkdir .githooks
git config gitflow.path.hooks .githooks

# Alternative: use core.hooksPath (also affects Git's own hooks)
git config core.hooksPath .githooks
```

--------------------------------

### Generate shell completion

Source: https://git-flow.sh/docs/commands

Generate scripts for bash, zsh, fish, or PowerShell.

```bash
git-flow completion [shell]
```

--------------------------------

### Shorthand Commands for Topic Branches

Source: https://git-flow.sh/docs/commands

Provides shorthand commands that operate on the current branch or accept an optional branch name for common topic branch operations like delete, update, rebase, rename, finish, and publish.

```bash
git-flow delete [name] - Delete current or specified topic branch
```

```bash
git-flow update [name] - Update current or specified topic branch from parent
```

```bash
git-flow rebase [name] - Rebase current or specified topic branch (alias for update —rebase)
```

```bash
git-flow rename [new-name] - Rename current topic branch
```

```bash
git-flow finish [name] - Finish current or specified topic branch
```

```bash
git-flow publish [name] - Push current or specified topic branch to remote
```

--------------------------------

### Custom Workflow Configuration

Source: https://git-flow.sh/docs/configuration

Defines a custom workflow with multiple environments and specific topic branch types.

```bash
# Custom workflow with multiple environments
git flow config add base production
git flow config add base staging production --auto-update=true
git flow config add base develop staging --auto-update=true

# Custom topic branch types
git flow config add topic feature develop --prefix=feat/
git flow config add topic bugfix develop --prefix=bug/
git flow config add topic epic develop --prefix=epic/
git flow config add topic release staging --prefix=release/ --tag=true
git flow config add topic hotfix production --prefix=hotfix/ --tag=true
```

--------------------------------

### Git Flow finish syntax

Source: https://git-flow.sh/docs/commands

General syntax for completing a topic branch.

```bash
git-flow <topic> finish [name] [options]
git-flow finish [options]  # shorthand for current branch
```

--------------------------------

### Git Configuration for Git Flow

Source: https://git-flow.sh/docs/configuration

This section shows the structure of git-flow configuration stored in the .git/config file. It includes settings for version, initialization, and various branch configurations like main, develop, feature, release, and their associated properties.

```gitconfig
[gitflow]
    version = 1.0
    initialized = true

[gitflow "branch.main"]
    type = base
    upstreamstrategy = none
    downstreamstrategy = none

[gitflow "branch.develop"]
    type = base
    parent = main
    autoupdate = true
    upstreamstrategy = merge
    downstreamstrategy = merge

[gitflow "branch.feature"]
    type = topic
    parent = develop
    prefix = feature/
    upstreamstrategy = merge
    downstreamstrategy = rebase

[gitflow "branch.release"]
    type = topic
    parent = main
    startpoint = develop
    prefix = release/
    upstreamstrategy = merge
    downstreamstrategy = merge
    tag = true
    tagprefix = v

```

--------------------------------

### Publish Topic Branch to Remote

Source: https://git-flow.sh/docs/commands

Push a topic branch to the remote repository. Use push options for platform-specific behaviors like skipping CI or creating merge requests. `--no-push-option` can override configured defaults.

```bash
git-flow <topic> publish [name] [-o option]... [--no-push-option]
```

```bash
git-flow publish [name]  # shorthand for current branch
```

```bash
# Publish current feature branch
git flow feature publish
```

```bash
# Publish specific feature
git flow feature publish user-authentication
```

```bash
# Publish using shorthand
git flow publish
```

```bash
# Publish a release branch
git flow release publish 1.0.0
```

```bash
# Publish with push option to skip CI
git flow feature publish my-feature -o ci.skip
```

```bash
# Publish and create a GitLab merge request
git flow feature publish my-feature -o merge_request.create -o merge_request.target=main
```

```bash
# Publish without any push options (override config defaults)
git flow feature publish my-feature --no-push-option
```

--------------------------------

### track

Source: https://git-flow.sh/docs/commands

Create a local branch that tracks a remote topic branch.

```APIDOC
## track

### Description
Create a local branch that tracks a remote topic branch, useful for collaborating on branches started by team members.

### Usage
git-flow <topic> track <name>
```

--------------------------------

### Post-flow Release Finish Hook

Source: https://git-flow.sh/docs/configuration

A post-hook script that notifies the user upon successful completion of a release.

```shell
#!/bin/sh
# .git/hooks/post-flow-release-finish
# Notify on release completion
if [ "$EXIT_CODE" -eq 0 ]; then
    echo "Release $VERSION completed successfully!"
fi
```

--------------------------------

### publish

Source: https://git-flow.sh/docs/commands

Push a topic branch to the remote repository, making it available for other team members to track.

```APIDOC
## publish

### Description
Push a topic branch to the remote repository, making it available for other team members to track.

### Usage
git-flow <topic> publish [name] [-o option]... [--no-push-option]
git-flow publish [name]

### Options
- **-o option, --push-option=option** - Transmit the given string to the server during push.
- **--no-push-option** - Suppress all push options, including configured defaults.
```

--------------------------------

### List Topic Branches with Pattern Filtering

Source: https://git-flow.sh/docs/commands

List existing topic branches of a specified type. Supports shell-style globbing for pattern filtering. Useful for finding branches that match a certain naming convention.

```bash
git-flow <topic> list [pattern]
```

```bash
# List all features
git flow feature list
```

```bash
# List all releases
git flow release list
```

```bash
# List features matching a pattern
git flow feature list "user-*"
```

```bash
# List releases for version 1.x
git flow release list "1.*"
```

--------------------------------

### list

Source: https://git-flow.sh/docs/commands

List existing topic branches of the specified type, with optional pattern filtering.

```APIDOC
## list

### Description
List existing topic branches of the specified type, with optional pattern filtering using shell-style globbing.

### Usage
git-flow <topic> list [pattern]
```

--------------------------------

### Manage git-flow configuration

Source: https://git-flow.sh/docs/configuration

Commands for managing base branches and topic branch types using the git-flow config interface.

```bash
git-flow config <command> [args] [options]
```

```bash
git-flow config list
```

```bash
git-flow config add base <name> [parent] [options]
```

```bash
git-flow config add topic <name> <parent> [options]
```

```bash
git-flow config edit base <name> [options]
```

```bash
git-flow config edit topic <name> [options]
```

```bash
git-flow config rename base <old-name> <new-name>
```

```bash
git-flow config rename topic <old-name> <new-name>
```

```bash
git-flow config delete base <name>
```

```bash
git-flow config delete topic <name>
```

--------------------------------

### Configure custom hooks path

Source: https://git-flow.sh/docs/configuration

Override the default hooks directory using gitflow.path.hooks. This setting supports absolute and relative paths.

```bash
# Absolute path
git config gitflow.path.hooks /shared/team-hooks

# Relative path (resolved from repository root)
git config gitflow.path.hooks .githooks

# Global default for all repositories
git config --global gitflow.path.hooks .githooks
```

--------------------------------

### Finish a feature branch

Source: https://git-flow.sh/docs/installation

Once development on a feature is complete, use this command to merge it back into the main development branch and clean up the feature branch. Replace 'my-feature' with the name of the feature you are finishing.

```bash
git flow feature finish my-feature
```

--------------------------------

### Update Topic Branch from Parent

Source: https://git-flow.sh/docs/commands

Update a topic branch from its parent branch using the configured downstream strategy. The `--rebase` option forces the rebase strategy, overriding configuration.

```bash
git-flow <topic> update [name] [options]
```

```bash
git-flow update [name]  # shorthand
```

```bash
# Update current branch
git flow update
```

```bash
# Update specific feature
git flow feature update user-auth
```

```bash
# Update with rebase regardless of configuration
git flow feature update my-feature --rebase
```

```bash
# Update release with latest hotfixes
git flow release update 1.2.0
```

--------------------------------

### Release Finish Tag Message Filter

Source: https://git-flow.sh/docs/configuration

A filter script that appends recent git log entries to the release tag message.

```shell
#!/bin/sh
# .git/hooks/filter-flow-release-finish-tag-message
# Append changelog to tag message
VERSION="$1"
MESSAGE="$2"
LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
if [ -n "$LAST_TAG" ]; then
    CHANGELOG=$(git log --oneline "${LAST_TAG}..HEAD" 2>/dev/null)
else
    CHANGELOG=$(git log --oneline -10 2>/dev/null)
fi
echo "${MESSAGE}

Changes in this release:
${CHANGELOG}"
```

--------------------------------

### rename

Source: https://git-flow.sh/docs/commands

Rename a topic branch while preserving Git history.

```APIDOC
## rename

### Description
Rename a topic branch while preserving Git history.

### Usage
git-flow <topic> rename <old-name> <new-name>
git-flow rename [new-name]
```

--------------------------------

### Git Flow Finish Command

Source: https://git-flow.sh/docs/commands

Completes a topic branch by merging it to its parent branch, with options for tag creation, branch retention, merge strategy, and remote synchronization.

```APIDOC
## git flow finish

### Description
Completes a topic branch by merging it to its parent branch according to the configured merge strategy. The finish operation handles merging, optional tag creation, child branch updates, and branch deletion, with conflict recovery support.

### Method
`git flow <topic> finish [name] [options]`
`git flow finish [options]` (shorthand for current branch)

### Parameters
#### Path Parameters
- **name** (string) - Optional - The name of the topic branch to finish. If not provided, the current branch is used.

#### Query Parameters

#### Request Body

### Operation Control Options
- `--continue, -c` - Continue after resolving merge conflicts.
- `--abort, -a` - Abort operation and return to original state.
- `--force, -f` - Force finish: skip remote branch sync check and allow finishing non-standard branches.

### Tag Creation Options
- `--tag` - Create a tag for the finished branch.
- `--notag` - Do not create a tag.
- `--sign` - Sign the tag cryptographically with GPG.
- `--no-sign` - Do not sign the tag.
- `--signingkey <keyid>` - Use specific GPG key.
- `--message, -m <message>` - Use given message for tag.
- `--messagefile <file>` - Use contents of file as tag message.
- `--tagname <name>` - Use specific tag name.

### Branch Retention Options
- `--keep` - Keep topic branch after finishing.
- `--no-keep` - Delete topic branch after finishing (default).
- `--keepremote` - Keep remote tracking branch.
- `--no-keepremote` - Delete remote tracking branch.
- `--keeplocal` - Keep local branch.
- `--no-keeplocal` - Delete local branch.
- `--force-delete` - Force delete even if not fully merged.
- `--no-force-delete` - Do not force delete (default).

### Merge Strategy Control Options
- `--rebase` - Rebase topic branch before merging.
- `--no-rebase` - Do not rebase (use configured strategy).
- `--squash` - Squash all commits into a single commit.
- `--no-squash` - Keep individual commits.
- `--squash-message <message>` - Custom commit message for squash merge (CLI-only, no config equivalent).
- `--merge-message, -M <message>` - Custom commit message for the upstream merge (topic to parent). Supports placeholders.
- `--update-message <message>` - Custom commit message for child branch updates (parent to child). Supports placeholders.
- `--preserve-merges` - Preserve merges during rebase.
- `--no-preserve-merges` - Flatten merges during rebase (default).
- `--no-ff` - Create merge commit even for fast-forward.
- `--ff` - Allow fast-forward merge when possible (default).

### Remote Fetch Options
- `--fetch` - Fetch from remote before finishing (default).
- `--no-fetch` - Do not fetch from remote before finishing.

### Hook Control Options
- `--no-verify` - Bypass pre-commit and commit-msg hooks during merge operations.

### Remote Sync Check
Before merging, finish checks if the local branch is in sync with its remote tracking branch:
  * **Equal/Ahead** : Finish proceeds normally
  * **Behind/Diverged** : Finish aborts to prevent data loss (use `--force` to bypass)

### Message Placeholders
Custom merge and update messages support these placeholders:
Placeholder| Description| Example  
---|---|---
`%b`| Branch name| `feature/my-feature`  
`%B`| Full refname| `refs/heads/feature/my-feature`  
`%p`| Parent branch| `develop`  
`%P`| Full parent refname| `refs/heads/develop`  
`%%`| Literal percent| `%`  

### Examples
```
# Finish current branch (shorthand)
git flow finish

# Finish specific feature
git flow feature finish user-authentication

# Finish release with signed tag
git flow release finish 1.2.0 --tag --sign

# Handle conflicts
git flow feature finish my-feature
# ... resolve conflicts ...
git flow feature finish my-feature --continue

# Force rebase strategy
git flow feature finish my-feature --rebase

# Squash all commits with custom message
git flow feature finish my-feature --squash --squash-message "feat: add user authentication"

# Custom merge message with placeholders
git flow feature finish my-feature --merge-message "feat: merge %b into %p"

# Custom messages for both merge and child updates
git flow release finish 1.2.0 \
  --merge-message "release: version 1.2.0" \
  --update-message "chore: sync %b from %p"

# Skip hooks during finish
git flow feature finish my-feature --no-verify

# Keep branch after finishing
git flow hotfix finish 1.1.1 --keep
```
```

--------------------------------

### Delete Topic Branch (Local and Remote)

Source: https://git-flow.sh/docs/commands

Delete a topic branch, optionally including the remote tracking branch. Use `--force` to delete branches with unmerged changes. `--no-force` and `--no-remote` can override configuration.

```bash
git-flow <topic> delete <name> [options]
```

```bash
git-flow delete [name]  # shorthand for current branch
```

```bash
# Delete specific feature
git flow feature delete old-feature
```

```bash
# Delete current branch
git flow delete
```

```bash
# Delete with remote cleanup
git flow feature delete my-feature --remote
```

```bash
# Force delete branch with unmerged changes
git flow feature delete experimental-feature --force
```

--------------------------------

### update

Source: https://git-flow.sh/docs/commands

Update topic branch from its parent branch using the configured downstream strategy.

```APIDOC
## update

### Description
Update topic branch from its parent branch using the configured downstream strategy.

### Usage
git-flow <topic> update [name] [options]

### Options
- **--rebase** - Force rebase strategy instead of configured downstream strategy
```

--------------------------------

### delete

Source: https://git-flow.sh/docs/commands

Delete a topic branch (local and/or remote).

```APIDOC
## delete

### Description
Delete a topic branch (local and/or remote).

### Usage
git-flow <topic> delete <name> [options]

### Options
- **--force, -f** - Force delete even if branch has unmerged changes
- **--no-force** - Don’t force delete
- **--remote, -r** - Delete remote tracking branch in addition to local
- **--no-remote** - Don’t delete remote tracking branch
```

--------------------------------

### Rename Topic Branch

Source: https://git-flow.sh/docs/commands

Rename a topic branch while preserving Git history. Supports renaming specific branches or the current branch using a shorthand.

```bash
git-flow <topic> rename <old-name> <new-name>
```

```bash
git-flow rename [new-name]  # shorthand for current branch
```

```bash
# Rename specific feature
git flow feature rename old-name new-name
```

```bash
# Rename current branch
git flow rename better-name
```

```bash
# Rename a release
git flow release rename 1.2.0 1.3.0
```
Tokens:
Raw