Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check

GitHub Action

Kubernetes yaml validation by kubeval

v1.0.0

Kubernetes yaml validation by kubeval

check

Kubernetes yaml validation by kubeval

Validate Kubernetes manifests by using Kubeval

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Kubernetes yaml validation by kubeval

              
  uses: makocchi-git/[email protected]
Learn more about this action in makocchi-git/actions-k8s-manifests-validate-kubeval

Choose a version

Validate Kubernetes manifests by kubeval

Validate Kubernetes manifests in your repository.
This action uses Kubeval for validating.

sample comment

Usage

Basic

# .github/workflows/manifests-validation.yml
name: Pull Request Check

on: [pull_request]

jobs:
  validation:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: validate manifests in dir1 and dir2
        uses: makocchi-git/[email protected]
        with:
          files: dir1,dir2
          token: ${{ secrets.GITHUB_TOKEN }}

Input parameters

Parameter Description Default
files Files or directories to validate .
version Version of Kubernetes to validate against master
strict Whether to not to check for extra properties true
openshift Whether to use the schemas from OpenShift rather than Kubernetes false
ignore_missing_schemas Whether or not to skip custom resources true
comment Write validation details to pull request comments true
token Github token for api. This is required if comment is true ""

NOTICE: Currently kubeval does not support to ignore specify files in the target directories. So when you set the files parameter to "."(default), your action would say "ERR - .github/workflows/your_action.yml: Missing 'kind' key".😥