action-conventional-commits

KO | EN

gitlite — search

#python #java #docker #hacktoberfest #react #nodejs #php #cluster #game #python3 #big-data #bert

action-conventional-commits

★ 76 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](https://raw.githubusercontent.com/webiny/action-conventional-commits/master/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.4.2`

```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.4.2
        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

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README