Giter Club home page Giter Club logo

docker-commitlint's Introduction

docker-commitlint

This is a preconfigured Docker image with commitlint. It has the following settings

  • Extend @commitlint/config-conventional
  • Disable the scope-case rule to allow any case
  • Custom imperative-tense rule to check subjects for imperative mood

๐Ÿš€ Usage

This image can be used in three ways.

  1. As a standalone commitlint CLI
  2. As a pre-commit hook
  3. As a GitHub action

CLI

$ docker pull extenda/commitlint
$ echo "feat: add feature" | docker run --rm -i extenda/commitlint
$ docker run --rm -i extenda/commitlint --from HEAD~1

Pre-Commit Hook

The image can be used to build a pre-commit hook. Extenda provides a commitlint pre-commit hook that can be configured like this:

- repo: [email protected]:extenda/pre-commit-hooks.git
  rev: v0.4
  hooks:
    - id: commitlint
      stages: [commit-msg]

GitHub Action

To support GitHub actions, the docker image offers an alternative entrypoint under /usr/local/bin/action.

Usage: action [-c <sha>] [-m <message>]

Extenda Retail provides a GitHub action out-of-the-box available at https://github.com/extenda/actions/commitlint.

๐Ÿ“ƒ License

This project is licensed under the MIT license.

Attributions

This project contains a list imperative mood blacklist from the MIT licensed git-good-commit project.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.