Conventional Commits Pull Request
ActionsLints pull requests based on Conventional Commits v1.0.0.
Also has the ability to post a comment in the pull request conversation with examples.
Live examples:
name: Pull Request Linter
on:
pull_request:
types:
- opened
- edited
- reopened
jobs:
lint:
name: Lint pull request title
runs-on: self-hosted
steps:
- name: Lint pull request title
uses: jef/conventional-commits-pr-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
comment
: Post a comment in the pull request conversation with examples. Default istrue
.token
[Required]: Access token to the repository. Usually${{ secrets.GITHUB_TOKEN }}
.
None.
There are few npm tasks that will help you in building and packaging. All commands are prefaced by npm run
.
build
: builds the action.compile
: transpiles TypeScript.clean
: removesbuild
directory.fix
: fixes lint and format issues.lint
: runs linter and checks format issues.start
: runs the action.test
: tests the action.
Conventional Commits Pull Request is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Conventional Commits Pull Request is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.