commit-check/commit-check-actionPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star13

Commit Check GitHub Action

License

MIT license

13 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Use this GitHub action with your project

Add this Action to an existing workflow or create a new one

View on Marketplace

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 134 Commits
.github		.github
.commit-check.yml		.commit-check.yml
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
LICENSE		LICENSE
README.md		README.md
action.yml		action.yml
main.py		main.py
requirements.txt		requirements.txt

Repository files navigation

Commit-Check GitHub Action

A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more.

Usage

Create a new GitHub Actions workflow in your project, e.g. at.github/workflows/commit-check.yml

name:Commit Checkon:push:pull_request:branches:'main'jobs:commit-check:runs-on:ubuntu-latestpermissions:# use permissions because use of pr-commentscontents:readpull-requests:writesteps:      -uses:actions/checkout@v4with:ref:${{ github.event.pull_request.head.sha }}# checkout PR HEAD commitfetch-depth:0# required for merge-base check      -uses:commit-check/commit-check-action@v1env:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}# use GITHUB_TOKEN because use of pr-commentswith:message:truebranch:trueauthor-name:trueauthor-email:truecommit-signoff:truemerge-base:falseimperative:falsejob-summary:truepr-comments:${{ github.event_name == 'pull_request' }}

Used By

Apache discovery-unicamp Texas Instruments OpenCADC ExtrawestChainlift Mila andmany more.

Optional Inputs

`message`

Description: check commit message formatting convention.
- By default, the rule followsconventional commits.
Default:true

`branch`

Description: check git branch naming convention.
- By default, the rule followsconventional branch.
Default:true

`author-name`

Description: check committer author name.
Default:true

`author-email`

Description: check committer author email.
Default:true

`commit-signoff`

Description: check committer commit signature.
Default:true

`merge-base`

Description: check current branch is rebased onto the target branch.
Default:false

Important

merge-base is an experimental feature. By default, it's disabled.

To use this feature, you need to fetch all history for all branches by settingfetch-depth: 0 inactions/checkout.

`imperative`

Description: check commit message is imperative mood.
Default:false

`dry-run`

Description: run checks without failing. exit code is 0; otherwise is 1.
Default:false

`job-summary`

Description: display job summary to the workflow run.
Default:true

`pr-comments`

Description: post results to the pull request comments.
Default:false

Important

pr-comments is an experimental feature. By default, it's disabled. To use it, you need to setGITHUB_TOKEN in the GitHub Action.

This feature currently doesn’t work with forked repositories. For more details, refer to issue#77.

Note: the default rule of above inputs is followingthis configuration. If you want to customize, just add your.commit-check.yml config file under your repository root directory.

GitHub Action Job Summary

By default, commit-check-action results are shown on the job summary page of the workflow.

Success Job Summary

Failure Job Summary

GitHub Pull Request Comments

Success Pull Request Comment

Failure Pull Request Comment

Badging Your Repository

You can add a badge to your repository to show your contributors/users that you use commit-check!

Markdown

[![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)

reStructuredText

.. image:: https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg    :target: https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml    :alt: Commit Check