git

Documentation

Overview

Package git provides an optional local git commit for board mutations by shelling out to the system git binary.

Only used when auto_commit: true in "north/config.yml". North never pushes or pulls — remote git is entirely the user's concern. Using the real git binary (rather than a reimplementation) means linked worktrees, hooks, commit signing, and includeIf config all behave exactly as the user's git does. If the board is not inside a git work tree, committing is silently skipped; if git itself is missing while auto_commit is on, that is a real error.

Index

• func CommitBoard(board, message string, paths, removed []string) error

Functions

func CommitBoard

func CommitBoard(board, message string, paths, removed []string) error

CommitBoard stages the given paths (and removals) and commits them locally. A no-op when the board is not in a git work tree. Only the given paths are committed — anything else the user has staged is left untouched. When no git identity is configured, a fallback "north" identity is used so the commit never fails half-way through a mutation.