README.md

Gitlint action

This action runs the gitlint tool on pull requests.

The gitlint configuration is taken from the first of the following:

• the config argument
• a file .gitlint in the top-level directory of the target repository
• the file .gitlint in directory misc/ of https://github.com/seL4/sel4_tools/

Content

The main action happens in steps.sh, the JavaScript entry point just calls this script.

Arguments

• token: GitHub PA token to authenticate for private repos (optional)
• config: gitlint config file location

Example:

    - uses: seL4/ci-actions/gitlint@master
      with:
        config: ./misc/my-gitlint-config

Example

Put this into a .github/workflows/ yaml file, e.g. gitlint.yml:

name: Gitlint

on: [pull_request]

jobs:
  gitlint:
    name: Gitlint
    runs-on: ubuntu-latest
    steps:
    - uses: seL4/ci-actions/gitlint@master