brigade/overcommit
Overcommit
Overcommit is a Git hook manager and workflow automation system used to configure, deploy, and orchestrate scripts that enforce coding standards and project workflows. It acts as a management layer for distributed hook configuration, applying global templates across multiple repositories to ensure consistent validation rules.
The system functions as a parallel task runner, executing multiple validation scripts concurrently across CPU cores to reduce the time spent during pre-commit checks. It distinguishes itself through signature-based integrity verification to detect unauthorized changes to plugin code and provides environment-based bypassing to conditionally skip specific validation scripts.
The project covers a wide range of capabilities, including pre-commit code validation with third-party linters, commit message standardization, and push requirement verification. It also automates post-checkout and post-merge tasks, manages hook dependencies, and utilizes glob-based filtering to restrict hook execution to specific files or branches.
Features
- Git Hook Managers - Provides a comprehensive system for configuring, deploying, and automating Git hooks.
- Git Hook Scripts - Allows the creation of repository-specific scripts to enforce coding standards.
- Pre-Commit Validations - Runs linters and syntax checkers against staged changes to prevent bugs and style violations from entering the repository.
- Commit Message Validation - Enforces formatting policies and content requirements on commit messages to ensure project history consistency.
- Configuration-Driven Orchestrators - Uses a declarative configuration file to manage the sequence and execution parameters of validation scripts.
- Custom Git Workflow Automations - Triggers dependency updates, cleanup tasks, and notifications automatically during various Git repository operations.
- Global Hook Registrations - Applies global hook templates across multiple repositories to ensure consistent validation rules across a team.
- Parallel Task Runners - Provides an execution engine that runs multiple Git hooks concurrently to accelerate pre-commit validation workflows.
- Fast Hook Runners - Executes multiple validation scripts concurrently across CPU cores to minimize the time spent during pre-commit checks.
- Pre-Commit Quality Hooks - Runs linters and syntax checkers against staged changes to prevent problematic code from being committed.
- Git Hook Configurations - Provides a centralized configuration system to define and orchestrate which Git hooks execute across repositories.
- VCS Automation Hooks - Automates the deployment and management of hooks across all new or cloned repositories.
- Hook Template Deployment - Copies standardized scripts from a global directory into local repositories to ensure consistent validation rules.
- Multi-Process Parallelism - Runs multiple validation scripts concurrently across CPU cores to minimize pre-commit wait times.
- Commit Message Standards - Enforces specific formatting and content rules for commit messages to ensure a searchable project history.
- Developer Governance Platforms - Shares and enforces a consistent set of Git hooks across a team to ensure all contributors follow same rules.
- Linter Integrations - Executes external linters to analyze source code for errors or style violations before committing.
- Hook Dependency Enforcement - Specifies version requirements for external dependencies to ensure consistent execution environments for automation scripts.
- Glob-Based File Filtering - Utilizes glob patterns to determine which scripts execute based on modified files.
- Git Hook Bypassing Mechanisms - Implements mechanisms to temporarily skip automated Git hook checks via environment variables.
- Runtime Dependency Management - Enforces specific versions of required executables or language libraries needed for hooks to run.
- Concurrent Hook Executions - Executes multiple validation scripts concurrently across CPU cores to reduce total pre-commit check time.
- Post-Checkout Automations - Triggers dependency installations or index updates automatically after changing branches or checking out files.
- Post-Merge Automations - Executes cleanup or installation tasks automatically after completing a successful merge.
- Push Requirement Verifiers - Executes test suites and branch protection checks during the push process to abort transfers if requirements fail.
- CI Pipeline Integrations - Allows the full suite of hooks to be triggered via the command line for CI pipeline validation.
- Custom Hook Environments - Allows adjusting command arguments and environment variables to customize how hooks behave.
- Ad-Hoc Hook Runs - Allows running configured hooks on demand for verification without performing a formal git commit.
- Hook Execution Filters - Restricts hook execution to specific files, branches, or remotes using glob patterns.
- Plugin Integrity Verification - Detects unauthorized changes to plugin code by comparing current signatures against a stored baseline.
- Plugin - Detects unauthorized changes to plugin code by comparing signatures against a stored baseline before execution.
- Environment-Based Hook Bypassing - Allows users to conditionally bypass specific validation scripts using system environment variables.
- Git Tools - Configurable manager for Git hooks.
- Hook Management Tools - Offers a highly configurable and extensible hook management system.
