https://github.com/luketainton/conventional-commits-check-action

A GitHub Action / Gitea Action for enforcing adherance to Conventional Commits. Mirrored from Gitea.
https://github.com/luketainton/conventional-commits-check-action

action commit conventional gitea gitea-actions github github-actions mirrored-from-gitea

Last synced: 8 days ago
JSON representation

A GitHub Action / Gitea Action for enforcing adherance to Conventional Commits. Mirrored from Gitea.

• Host: GitHub
• URL: https://github.com/luketainton/conventional-commits-check-action
• Owner: luketainton
• License: unlicense
• Created: 2025-01-02T22:49:51.000Z (22 days ago)
• Default Branch: main
• Last Pushed: 2025-01-15T21:58:50.000Z (9 days ago)
• Last Synced: 2025-01-15T23:45:08.043Z (9 days ago)
• Topics: action, commit, conventional, gitea, gitea-actions, github, github-actions, mirrored-from-gitea
• Language: Dockerfile
• Homepage: https://git.tainton.uk/actions/conventional-commits-check-action
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Conventional Commits Check Action

A [GitHub Action](https://github.com/features/actions) / [Gitea Action](https://docs.gitea.com/usage/actions/overview) for enforcing adherance to [Conventional Commits](https://pypi.org/project/conventional-pre-commit/).

You can use the Action as follows:

```yaml

name: Validate PR Title

on:

  pull_request_target:

    types:

      - opened

      - edited

      - synchronize

      - reopened

      - labeled

      - unlabeled

jobs:

  validate:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

      - uses: https://git.tainton.uk/actions/[email protected]

        with:

          commit-message: ${{ github.event.pull_request.title }}

```

```yaml

name: Validate Commit Message

on:

  push:

    branches:

      - main

jobs:

  validate:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

      - uses: https://git.tainton.uk/actions/[email protected]

        with:

          commit-message: ${{ github.event.head_commit.message }}

```

## Properties

The Conventional Commits Check Action has a property which is passed to the underlying script. These are passed to the action using `with`.

| Property       | Description                                    |

| -------------- | ---------------------------------------------- |

| commit-message | The commit message you would like to validate. |