-
Notifications
You must be signed in to change notification settings - Fork 27
68 lines (66 loc) · 2.13 KB
/
documentation.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# 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@v3
- 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.20.7'
- 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