kevindejong-tomtom/commisery-action

GitHub action for running Conventional Commit message checker (Commisery) on push

⚠️⚠️⚠️ THIS ACTIONS HAS BEEN DEPRECATED IN FAVOR OF OUR OFFICIAL COMMISERY ACTION ⚠️⚠️⚠️

There will be NO maintenance support of this version and the action has been DELISTED from the GitHub Marketplace

Check your commits against Conventional Commits using Commisery

Using this GitHub action, scan all commits in your Pull Request against the Conventional Commits standard using Commisery

Prerequisites

• Commisery requires at least Python>3.8
• pip needs to be installed for this Python version

Usage

The workflow, usually declared in .github/workflows/build.yml, looks like:

    name: Commisery
    on: 
      pull_request:
        types: [edited, opened, synchronize, reopened]

    jobs:
      commit-message:
        name: Conventional Commit Message Checker (Commisery)
        runs-on: ubuntu-latest
        steps:       
        - name: Check-out the repo under $GITHUB_WORKSPACE
          uses: actions/checkout@v3

        - name: Setup Python 3.8
          uses: actions/setup-python@v3
          with:
            python-version: 3.8

        - name: Run Commisery
          uses: KevinDeJong-TomTom/commisery-action@master
          with:
            token: ${{ secrets.GITHUB_TOKEN }}
            pull_request: ${{ github.event.number }}

Inputs

• token: GitHub Token provided by GitHub, see Authenticating with the GITHUB_TOKEN
• pull_request: Pull Request number, provided by the GitHub context.

Example of Conventional Commit check results