From bc0facd76a7b82ebb4445c7826a84f9d8e4f9058 Mon Sep 17 00:00:00 2001 From: ArchitectBot <61872893+architectbot@users.noreply.github.com> Date: Tue, 14 Nov 2023 12:19:48 +0100 Subject: [PATCH] Align files (#420) Co-authored-by: github-actions --- .../zz_generated.check_values_schema.yaml | 2 +- .../zz_generated.create_release.yaml | 2 +- .../zz_generated.create_release_pr.yaml | 2 +- ..._generated.diff_helm_render_templates.yaml | 2 +- ...zz_generated.documentation_validation.yaml | 43 +++++++++++++++++++ .github/workflows/zz_generated.gitleaks.yaml | 2 +- .../zz_generated.json_schema_validation.yaml | 2 +- Makefile | 2 +- Makefile.gen.app.mk | 2 +- Makefile.gen.cluster_app.mk | 2 +- 10 files changed, 52 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/zz_generated.documentation_validation.yaml diff --git a/.github/workflows/zz_generated.check_values_schema.yaml b/.github/workflows/zz_generated.check_values_schema.yaml index 1ec199ba..612717b5 100644 --- a/.github/workflows/zz_generated.check_values_schema.yaml +++ b/.github/workflows/zz_generated.check_values_schema.yaml @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # name: 'Values and schema' on: diff --git a/.github/workflows/zz_generated.create_release.yaml b/.github/workflows/zz_generated.create_release.yaml index 0b41b518..107f0894 100644 --- a/.github/workflows/zz_generated.create_release.yaml +++ b/.github/workflows/zz_generated.create_release.yaml @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # name: Create Release on: diff --git a/.github/workflows/zz_generated.create_release_pr.yaml b/.github/workflows/zz_generated.create_release_pr.yaml index c7c2e300..8735030c 100644 --- a/.github/workflows/zz_generated.create_release_pr.yaml +++ b/.github/workflows/zz_generated.create_release_pr.yaml @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # name: Create Release PR on: diff --git a/.github/workflows/zz_generated.diff_helm_render_templates.yaml b/.github/workflows/zz_generated.diff_helm_render_templates.yaml index 80def9a7..c996ebf6 100644 --- a/.github/workflows/zz_generated.diff_helm_render_templates.yaml +++ b/.github/workflows/zz_generated.diff_helm_render_templates.yaml @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # name: Compare Helm Rendering diff --git a/.github/workflows/zz_generated.documentation_validation.yaml b/.github/workflows/zz_generated.documentation_validation.yaml new file mode 100644 index 00000000..853cbac9 --- /dev/null +++ b/.github/workflows/zz_generated.documentation_validation.yaml @@ -0,0 +1,43 @@ +# DO NOT EDIT. Generated with: +# +# devctl@6.17.0 +# + +# This workflow validates the documentation generated from the JSON schema of the cluster-app +# which is located in `helm/*/values.schema.json`. Specifically, it checks whether the changes +# from `make generate-docs` were committed. + +name: Documentation validation +on: + pull_request: + branches: + - master + - main + paths: + - 'helm/**/values.yaml' + - 'helm/**/values.schema.json' + - '**/*.md' # if someone manually edited a file that should contain the generated documentation + + push: {} + +jobs: + validate: + name: Validate documentation + runs-on: ubuntu-latest + env: + GO_VERSION: 1.21.3 + steps: + - name: Set up Go ${{ env.GO_VERSION }} + uses: actions/setup-go@v3.3.0 + with: + go-version: ${{ env.GO_VERSION }} + - name: Checkout code + uses: actions/checkout@v4 + - name: "Run 'make generate-docs' and check for differences" + run: | + make generate-docs + + if ! git diff --exit-code; then + echo "ERROR: You need to commit the changes made by \"make generate-docs\"." + exit 1 + fi diff --git a/.github/workflows/zz_generated.gitleaks.yaml b/.github/workflows/zz_generated.gitleaks.yaml index e0f54003..bb1726e7 100644 --- a/.github/workflows/zz_generated.gitleaks.yaml +++ b/.github/workflows/zz_generated.gitleaks.yaml @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # name: gitleaks diff --git a/.github/workflows/zz_generated.json_schema_validation.yaml b/.github/workflows/zz_generated.json_schema_validation.yaml index f37ea458..79a4db3d 100644 --- a/.github/workflows/zz_generated.json_schema_validation.yaml +++ b/.github/workflows/zz_generated.json_schema_validation.yaml @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # # This workflow validates the JSON schema of the cluster-app, which is located in diff --git a/Makefile b/Makefile index 4a65c648..ee1829c4 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # include Makefile.*.mk diff --git a/Makefile.gen.app.mk b/Makefile.gen.app.mk index 894cc14c..590e85a3 100644 --- a/Makefile.gen.app.mk +++ b/Makefile.gen.app.mk @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # ##@ App diff --git a/Makefile.gen.cluster_app.mk b/Makefile.gen.cluster_app.mk index 8d31d190..c739a77c 100644 --- a/Makefile.gen.cluster_app.mk +++ b/Makefile.gen.cluster_app.mk @@ -1,6 +1,6 @@ # DO NOT EDIT. Generated with: # -# devctl@6.16.0 +# devctl@6.17.0 # ##@ Schema