Ensures that all commits are following the conventional-commits standard.
Find a file
2024-01-26 16:25:14 +01:00
dist/main wip: prepare 1.3.0 release 2024-01-26 16:25:14 +01:00
docs chore: update README 2020-06-11 10:01:04 +02:00
src feat: introduce allowed-commit-types input 2023-11-23 22:31:51 +01:00
.gitignore chore: initial commit 2020-06-11 07:50:40 +02:00
.prettierrc.js chore: initial commit 2020-06-11 07:50:40 +02:00
action.yml fix: updated action to node20; added lock file 2024-01-26 16:21:08 +01:00
babel.config.js chore: add jest 2020-06-11 12:55:07 +02:00
CONTRIBUTING.md docs: add Getting Started section 2022-10-18 13:51:37 +02:00
index.js feat: create action 2020-06-11 09:37:37 +02:00
jest.config.js chore: add jest 2020-06-11 12:55:07 +02:00
package.json fix: update deps 2023-11-23 22:31:51 +01:00
README.md wip: prepare 1.3.0 release 2024-01-26 16:25:14 +01:00
tsconfig.json chore: update target 2022-06-12 19:14:17 +02:00

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/action-conventional-commits@v1.3.0
        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.