Skip to content
git-pull-request

GitHub Action

committed-action

v1.1.5 Latest version

committed-action

git-pull-request

committed-action

Run committed to check commit history

Installation

Copy and paste the following snippet into your .yml file.

              

- name: committed-action

uses: crate-ci/[email protected]

Learn more about this action in crate-ci/committed

Choose a version

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:

cargo install committed

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.5
    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.

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

Basic Usage

Verify your latest commit

committed HEAD

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.

License

Licensed under either of

at your option.