From 57e52867bcb74a642e84f998e539e3218be30072 Mon Sep 17 00:00:00 2001 From: Nicolas Vuillamy Date: Sun, 14 May 2023 15:59:29 +0200 Subject: [PATCH] Add MegaLinter in CI section + fix Table of Contents links --- Readme.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/Readme.md b/Readme.md index 4fc2f9b..e13cff3 100644 --- a/Readme.md +++ b/Readme.md @@ -38,20 +38,21 @@ sys 0m1,069s ## Table of contents * [A small overview of Kubernetes manifest validation](#a-small-overview-of-kubernetes-manifest-validation) - * [Limits of Kubeconform validation](#Limits-of-Kubeconform-validation) -* [Installation](#Installation) -* [Usage](#Usage) - * [Usage examples](#Usage-examples) - * [Proxy support](#Proxy-support) -* [Overriding schemas location](#Overriding-schemas-location) - * [CustomResourceDefinition (CRD) Support](#CustomResourceDefinition-(CRD)-Support) - * [OpenShift schema Support](#OpenShift-schema-Support) -* [Integrating Kubeconform in the CI](#Integrating-Kubeconform-in-the-CI) - * [Github Workflow](#Github-Workflow) - * [Gitlab-CI](#Gitlab-CI) + * [Limits of Kubeconform validation](#limits-of-kubeconform-validation) +* [Installation](#installation) +* [Usage](#usage) + * [Usage examples](#usage-examples) + * [Proxy support](#proxy-support) +* [Overriding schemas location](#overriding-schemas-location) + * [CustomResourceDefinition (CRD) Support](#customresourcedefinition-crd-support) + * [OpenShift schema Support](#openshift-schema-support) +* [Integrating Kubeconform in the CI](#integrating-kubeconform-in-the-ci) + * [Github Workflow](#github-workflow) + * [Gitlab-CI](#gitlab-ci) + * [MegaLinter](#megalinter) * [Helm charts](#helm-charts) -* [Using kubeconform as a Go Module](#Using-kubeconform-as-a-Go-Module) -* [Credits](#Credits) +* [Using kubeconform as a Go Module](#using-kubeconform-as-a-go-module) +* [Credits](#credits) ## A small overview of Kubernetes manifest validation @@ -332,6 +333,12 @@ lint-kubeconform: See [issue 106](https://github.com/yannh/kubeconform/issues/106) for more details. +### MegaLinter + +Kubeconform is [natively embedded in MegaLinter](https://megalinter.io/latest/descriptors/kubernetes_kubeconform/), an open-source linters aggregator, which is compliant with GitHub Actions, Gitlab CI, Azure Pipelines, Bitbucket Pipelines, Drone CI, Jenkins, Concourse… + +To install its configuration, just run `npx mega-linter-runner --install` at the root of your repository (requires Node.js installed) + ## Helm charts There is a 3rd party [repository](https://github.com/jtyr/kubeconform-helm) that