You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Conform Action
v0.1.0-alpha.17
Pre-release
Policy enforcement for your pipelines.
Conform is a tool for enforcing policies on your build pipelines.
Some of the policies included are:
- Commits: Enforce commit policies including:
- Commit message header length
- Developer Certificate of Origin
- GPG signature
- Conventional Commits
- Imperative mood
- Maximum of one commit ahead of
master - Require a commit body
- License Headers: Enforce license headers on source code files.
Create a file named .conform.yaml with the following contents:
policies:
- type: commit
spec:
headerLength: 89
dco: true
gpg: false
imperative: true
maximumOfOneCommit: true
requireCommitBody: true
conventional:
types:
- "type"
scopes:
- "scope"
- type: license
spec:
skipPaths:
- .git/
- .build*/
includeSuffixes:
- .ext
excludeSuffixes:
- .exclude-ext-prefix.ext
header: |
This is the contents of a license header.In the same directory, run:
$ conform enforce
POLICY CHECK STATUS MESSAGE
commit Header Length PASS <none>
commit DCO PASS <none>
commit Imperative Mood PASS <none>
commit Conventional Commit PASS <none>
commit Number of Commits PASS <none>
commit Commit Body PASS <none>
license File Header PASS <none>