https://github.com/webiny/action-conventional-commits

Ensures that all commits are following the conventional-commits standard.
https://github.com/webiny/action-conventional-commits

Last synced: 10 months ago
JSON representation

Ensures that all commits are following the conventional-commits standard.

• Host: GitHub
• URL: https://github.com/webiny/action-conventional-commits
• Owner: webiny
• Created: 2020-06-11T05:47:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-26T15:42:46.000Z (over 2 years ago)
• Last Synced: 2024-12-05T08:38:13.119Z (over 1 year ago)
• Language: TypeScript
• Size: 333 KB
• Stars: 54
• Watchers: 2
• Forks: 30
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# Conventional Commits GitHub Action

A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification.

![Screenshot](/docs/screenshot.png)

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

### Usage

Latest version: `v1.3.0`

```yml

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.

```