Home

git-flow (LBEM Edition)

git-flow LBEM Edition is a fork of gitflow-cjs maintained by LBEM (Laboratory of Biological Electron Microscopy) that adds additional features for improved workflow integration.

Why LBEM Edition?

The LBEM Edition adds several productivity features on top of gitflow-cjs:

• Sync command - Synchronize your feature/bugfix branch with updates from the base branch (inspired by git-town)
• Sync prune - Automatically clean up stale local branches whose remote tracking branches have been deleted
• Propose command - Create pull/merge requests directly from the command line
• PR alias - Use git flow feature pr as shorthand for git flow feature propose
• Draft PRs - Create draft pull requests with --draft flag or configure as default
• PR assignees/reviewers - Set assignees and reviewers with --assignee and --reviewer flags
• PR labels - Add labels with --label flag or auto-label based on branch type
• GitHub/GitLab releases - Create releases automatically with --create-release on finish
• Configurable finish mode - Choose between classic merge, propose PR, or ask each time
• Team configuration file - Share git-flow settings via a .gitflow file in your repository
• GitHub-merge detection - Safely finish branches that were merged via GitHub/GitLab web UI

What is git-flow?

git-flow is a collection of Git extensions to provide high-level repository operations for Vincent Driessen's branching model.
The LBEM Edition is based on the CJS Edition, which is an updated fork of the AVH Edition. The AVH Edition adds more functionality to the existing git-flow and several of the internal commands have been rewritten to speed up the software.

Installing git-flow

Please refer to the Installation Instructions for detailed installation steps for your platform.

Reference

• General An overview of general commands, like shortcuts.
• git flow init
• git flow feature
• git flow bugfix
• git flow release
• git flow hotfix
• git flow support
• git flow version
• git flow config
• Configuration
• Hooks and Filters

Frequently Asked Questions

Visit the FAQ Page.

Contributing

For LBEM Edition Features

If you're contributing features specific to the LBEM Edition (sync, propose, finish modes, .gitflow config, etc.):

• Please fork and clone gitflow-lbem
• Create a feature branch: git flow feature start <feature-name>
• Make your changes and commit them
• Push your feature branch to your fork
• Submit a pull request to LBEM-CH/gitflow-lbem

For Upstream CJS/AVH Issues

If submitting a pull request addressing an issue with the upstream gitflow-cjs or gitflow-avh:

• For CJS issues: CJ-Systems/gitflow-cjs - See their contributing guidelines
• For AVH issues: petervanderdoes/gitflow-avh - Note: This repository is unmaintained and archived since June 2023

How to submit a pull request

For any new PRs you can use one of the keywords from Linking a pull request to an issue to automatically close the related issue.

Guidelines

• Reporting issues/new features
• We follow the Coding guidelines from the gitflow-cjs project.