GitHub - crate-ci/committed: Nitpicking commit history since beabf39

2 min read Original article ↗

committed

Nitpicking commit history since beabf39

codecov Documentation License Crates Status

Enforce commit standards, whether for:

  • Readability, especially in logs
  • Consistent styling
  • Compatibility with programmatic processing

Install

Download a pre-built binary (installable via gh-install.

Or use rust to install:

pre-commit

To use committed with pre-commit, point its config at this repository:

repos:
  - repo: https://github.com/crate-ci/committed
    rev: v1.1.8
    hooks:
      - id: committed

The committed id installs a prebuilt executable from GitHub releases. If one does not exist for the target platform, or if one built from sources is preferred, use committed-src as the hook id instead.

Be sure to change rev to use the desired committed git tag or revision.

By default, the pre-commit install only installs hooks of the pre-commit type, so you may need to list the commit-msg hook during installation:

pre-commit install -t pre-commit -t commit-msg

or update your .pre-commit-config.yaml like so:

default_install_hook_types: [pre-commit, commit-msg]

The hook, by default, will verify your commit message.

Basic Usage

Verify your latest commit

Verify your branch

committed master..HEAD --no-merge-commit

Have your CI verify your PR (assuming it does a no-ff merge into your master)

committed HEAD~..HEAD^2 --no-merge-commit

See imperative for a GitHub Actions example or look at committeds own GitHub Actions pipeline, .travis.yml, or appveyor.yml.

Reference

Contribute

License

Licensed under either of

at your option.