chore: policy linting #653
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2022 Google LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # https://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: Documentation checks | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| linting: | |
| name: Documentation linting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Check license headers | |
| run: python3 scripts/license_header_check.py $GITHUB_WORKSPACE | |
| - name: Markdown linter | |
| uses: avto-dev/markdown-lint@v1 | |
| with: | |
| config: '.markdownlint.yml' | |
| args: '**/*.md' | |
| - name: Markdown links | |
| uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| with: | |
| config-file: '.mlc_config.json' | |
| base-branch: main | |
| policy-doc: | |
| name: Policy documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: '1.22' | |
| check-latest: true | |
| - name: Get dependencies | |
| run: go mod download | |
| - name: Build | |
| run: make build | |
| - name: Generate policy documentation | |
| run: ./gke-policy generate policy-docs -s --creds internal/app/test-fixtures/test_credentials.json --local-policy-dir ./gke-policies-v2 -f generated-policy-docs.md | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Check policy documentation | |
| run: python3 scripts/policyDocCheck.py gke-policies-v2/README.md generated-policy-docs.md |