README.md

Prometheus Operator Linting GitHub Action

Introduction

This simple GitHub Action allows to run po-lint on any kubernetes prometheus operator CRDs.

Success Criteria

An exit code of 0 is considered a successful execution.

Usage

name: Check Prometheus Operator CRDs
on:
  pull_request: {}

jobs:
  polint:
    name: Prometheus operator linter
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: theodore86/polint-github-action@v2
        with:
          path: './crds'
          exclude: '.*test.*'

Inputs

Name	Description	Default
path	Absolute or relative path to the Prometheus Operator CRDs	./
glob_pattern	Rule file extension as glob pattern	*.y*ml
exclude	Regex to exclude files or folders from linting	none