Git Product home page Git Product logo

action-conventional-commits's Introduction

Conventional Commits GitHub Action

A simple GitHub action that makes sure all commit messages are following the Conventional Commits specification.

Screenshot

Note that, typically, you would make this check on a pre-commit hook (for example, using something like Commitlint), but those can easily be skipped, hence this GitHub action.

Usage

Latest version: v1.3.0

name: Conventional Commits

on:
  pull_request:
    branches: [ master ]

jobs:
  build:
    name: Conventional Commits
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: webiny/[email protected]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Optional, for private repositories.
          allowed-commit-types: "feat,fix" # Optional, set if you want a subset of commit types to be allowed.

action-conventional-commits's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

action-conventional-commits's Issues

Add configurable result message on failure

Would it be possible to add the ability to have a custom message when someone fails to follow convention? We have certain tools where it'd be beneficial to link to our own custom docs or provide guidance specific to those tools.

Extra code embedded from dependencies

Hi,
thanks for this nice action, looks very interesting.
However I was wondering why the built files contain a lot of code that doesn't seem related to commit validation (TunnelingAgent, EventEmitter, ...) Probably from a dependency; maybe those could be removed?

No commits to check on all `pull_request` event

Hello,

Thank you for the super useful action! We have used multiple event triggers, and for pull_request, the git action always says there is no commit to check. See example below.
image

The definition is

name: 'Enforce conventional commits on all commit push'

on: [create, push, pull_request, pull_request_review, pull_request_target]

jobs:
  build:
    name: Conventional Commits
    runs-on: ubuntu-latest
    steps:
      - id: checkout
        uses: actions/checkout@v2

      - id: enforce-commit-msg-style
        uses: webiny/[email protected]

Can you advise? Thank you!

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.