Release v0.1.1 (What’s new?).

Documentation Status https://github.com/MacHu-GWU/semantic_branch-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/semantic_branch-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/semantic-branch.svg https://img.shields.io/pypi/l/semantic-branch.svg https://img.shields.io/pypi/pyversions/semantic-branch.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to semantic_branch Documentation

https://semantic-branch.readthedocs.io/en/latest/_static/semantic_branch-logo.png

What is Semantic Branch?

semantic_branch is a Python library that provides a comprehensive system for working with semantic git branch names. It offers a structured approach to branch naming that helps developers and CI/CD systems understand the purpose and type of work being done on a branch.

The library allows you to:

  • Validate branch names against a set of semantic rules

  • Detect branch types (feature, fix, release, etc.)

  • Ensure consistent branch naming across development workflows

  • Provide robust branch name parsing and categorization

Key Features:

  • Validate semantic branch names

  • Detect branch types using predefined semantic stubs

  • Support for various branch naming conventions

For a complete guide with detailed usage examples and advanced techniques, visit the comprehensive documentation.

Install

semantic_branch is released on PyPI, so all you need is to:

$ pip install semantic-branch

To upgrade to latest version:

$ pip install --upgrade semantic-branch

Table of Content

About the Author

(\ (\
( -.-)o
o_(")(")

Sanhe Hu is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of 150+ open-source Python projects, with over 15 million monthly downloads, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in AI, Data, Amazon Web Services, Cloud Engineering, DevOps, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.

Talk is cheap, show me the code:

API Document