Authoring Module Reference

Authoring Module Reference

The authoring module controls how commit author information is handled.

Functions

authoring.pass_thru

Preserve original author when possible:

authoring.pass_thru(
    default = "Bot <bot@example.com>",  # Fallback author
)

authoring.overwrite

Replace all authors:

authoring.overwrite(
    "Bot <bot@example.com>",            # Author for all commits
)

authoring.allowed

Allow specific authors, default for others:

authoring.allowed(
    default = "Bot <bot@example.com>",  # Fallback author
    allowlist = [                       # Preserved authors
        "alice@example.com",
        "bob@example.com",
    ],
)

Author Format

Authors use Git standard format:

Name <email@example.com>

Examples

Open Source Export

authoring = authoring.pass_thru(
    default = "Open Source Bot <oss@company.com>",
)

Bot-Only Commits

authoring = authoring.overwrite(
    "Sync Bot <sync@company.com>",
)

Allow Internal Team

authoring = authoring.allowed(
    default = "External <external@company.com>",
    allowlist = [
        "*@company.com",
    ],
)

Next Steps

• Glob reference
• Metadata transformations