conform

command module
v0.1.0-alpha.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2019 License: MPL-2.0 Imports: 1 Imported by: 0

README

Conform

Policy enforcement for your pipelines.

Conventional Commits GoDoc Travis Codecov Go Report Card Release GitHub (pre-)release


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
  • License Headers: Enforce license headers on source code files.

Getting Started

Create a file named .conform.yaml with the following contents:

policies:
- type: commit
  spec:
    headerLength: 89
    dco: true
    gpg: true
    imperative: true
    conventional:
      types:
        - "type"
      scopes:
        - "scope"
- type: license
  spec:
    skipPaths:
    - .git/
    - .build*/
    includeSuffixes:
    - .ext
    excludeSuffixes:
    - .exclude-ext-prefix.ext
    headerFile: LICENSE_HEADER

In the same directory, run:

$ conform enforce
POLICY                    STATUS        MESSAGE
commit                    PASS          <none>
license                   PASS          <none>

License

license

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
git

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL