Crate git_checks

Basic Checks

Simple checks useful in a wide variety of projects.

Modules

builders

Module for all builders for checks.

config

Configuration structures for checks.

Structs

AllowRobot

A check to allow robots to skip all checks.

BadCommit

Check for commits which should not be in the history.

BadCommits

Check for commits which should not be in the history.

Changelog

Check for changelog modifications.

CheckEndOfLine

Check for files which lack an end-of-line at the end of the file.

CheckExecutablePermissions

Checks whether a file’s executable permissions matches its contents.

CheckSize

Checks that files committed to the tree do not exceed a specified size.

CheckWhitespace

Checks for bad whitespace using Git’s built-in checks.

CommitSubject

Check commit message subjects for invalid patterns.

FastForward

A check which checks for fast-forward merge statuses.

Formatting

Run a formatter in the repository to check commits for formatting.

InvalidPaths

A check which denies commits which adds files containing special characters in their paths.

InvalidUtf8

A check which denies commits which modify files containing special characters.

LfsPointer

A check which verifies that files meant to be under LFS control are valid LFS pointers.

RejectBiDi

A check which denies commits which add text lines containing bidirectional control characters.

RejectBinaries

Reject binary files.

RejectConflictPaths

A check which denies paths which look like merge conflict resolution paths.

RejectMerges

A check which denies merge commits, including octopus merges.

RejectSeparateRoot

A check which denies root commits.

RejectSymlinks

Rejects the addition of symlinks to a repository.

ReleaseBranch

A check which checks for release branch eligibility.

RestrictedPath

A check which denies commits which modify files underneath certain path.

SubmoduleAvailable

Check that submodules are reachable from a given branch and available.

SubmoduleRewind

Check that submodules are not rewound to older revisions.

SubmoduleWatch

Check that submodules are reachable from a given branch and available.

ThirdParty

Description of a third party package imported using Kitware’s third party import process.

ValidName

A check which checks for valid identities.

Enums

ChangelogStyle

The style of changelog management in use.

ValidNameFullNamePolicy

Configuration value for ValidName policy for use of full names in identities.