bugyo-git 1.1.0

Git repository plugin for Daimyo - provides Git context for templates

bugyo-git

Git repository plugin for Daimyo - provides Git context, filters, and tests for Jinja2 templates.

Installation

pip install bugyo-git

Requirements

• Python >= 3.11
• daimyo >= 1.4.0
• GitPython ~= 3.1

Note: This plugin requires GitPython and only works inside Git repositories.

Features

Context Variables

The git.context plugin provides:

Variable	Type	Description
git_branch	str	Current branch name
git_commit	str	Current commit SHA (short, 7 chars)
git_commit_full	str	Full commit SHA (40 chars)
git_author	str	Commit author name
git_author_email	str	Commit author email
git_remote	str|None	Remote URL (if configured)
git_remote_name	str|None	Remote name (e.g., "origin")
git_remote_domain	str|None	Remote URL domain with port (if any)
git_remote_domain_no_port	str|None	Remote URL domain without port
git_push_url	str|None	Push URL (if configured, may differ from remote URL)
git_push_domain	str|None	Push URL domain with port (if any)
git_push_domain_no_port	str|None	Push URL domain without port
git_is_clean	bool	True if no uncommitted changes
git_tag	str|None	Tag name if current commit is tagged
git_root	str	Git repository root path

Filters

The git.filters plugin provides:

Filter	Description	Example
git_short_sha	Shorten SHA to N chars	commit | git_short_sha(10)
git_branch_name	Extract branch from ref	"refs/heads/main" | git_branch_name

Tests

The git.filters plugin provides:

Test	Description	Example
is_git_repo	Check if path is git repo	"." is is_git_repo
is_clean	Check if working dir is clean	git_is_clean is is_clean
has_uncommitted	Check for uncommitted changes	true is has_uncommitted
on_branch	Check if on specific branch	"main" is on_branch("main")
has_remote	Check if remote exists	"origin" is has_remote("origin")

Configuration

Enable in .daimyo/config/settings.toml:

# Enable all Git plugins
enabled_plugins = ["git.*"]

# Or enable specific plugins
enabled_plugins = ["git.context", "git.filters"]

Usage Examples

Branch-Specific Rules

In your YAML rule files:

code.review:
  when: Code review guidelines
  ruleset:
    - "{% if git_branch is on_branch('main') %}Code must pass all CI checks before merging{% endif %}"
    - "{% if git_branch is on_branch('main') %}Require code review from at least 2 reviewers{% endif %}"
    - "{% if git_branch is on_branch('develop') %}Code must pass unit tests{% endif %}"
    - "{% if git_branch is on_branch('develop') %}Require code review from at least 1 reviewer{% endif %}"

Commit Information

git.info:
  when: Git commit information
  ruleset:
    - "Current commit: {{ git_commit }}"
    - "Author: {{ git_author }} <{{ git_author_email }}>"
    - "{% if git_tag %}This is a tagged release: {{ git_tag }}{% endif %}"

Clean Repository Checks

git.status:
  when: Repository status checks
  ruleset:
    - "{% if not (git_is_clean is is_clean) %}Warning: You have uncommitted changes{% endif %}"
    - "{% if not (git_is_clean is is_clean) %}Please commit or stash your changes before proceeding{% endif %}"

Remote Configuration

git.remote:
  when: Remote repository configuration
  ruleset:
    - "{% if git_remote %}Remote: {{ git_remote_name }} ({{ git_remote }}){% endif %}"
    - "{% if not git_remote %}No remote configured - remember to push your changes{% endif %}"

CI Pipeline Rules Based on Repository Domain

ci.pipeline:
  when: CI pipeline configuration
  ruleset:
    - "{% if git_push_domain_no_port == 'github.com' %}Use GitHub Actions workflow{% endif %}"
    - "{% if git_push_domain_no_port == 'gitlab.com' %}Use GitLab CI/CD pipeline{% endif %}"
    - "{% if git_remote_domain_no_port == 'gitlab.example.com' %}Use custom GitLab instance CI/CD{% endif %}"
    - "{% if git_push_domain == 'gitlab.example.com:8443' %}Configure custom SSL port for CI{% endif %}"

Availability

This plugin is only available when:

1. GitPython is installed
2. Running inside a Git repository

If GitPython is not installed or not in a Git repository, the plugin will gracefully disable itself.

License

MIT License - see LICENSE file for details.

Support

For issues and questions, visit the Daimyo issue tracker.