Verify docs #927
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
| name: Verify docs | |
| on: | |
| schedule: | |
| # every day at 9am | |
| - cron: '0 9 * * *' | |
| jobs: | |
| verify: | |
| name: Verify docs and spelling | |
| if: github.repository == 'antrea-io/antrea' | |
| runs-on: [ubuntu-latest] | |
| steps: | |
| - name: Check-out code | |
| uses: actions/checkout@v4 | |
| - name: Set up Go using version from go.mod | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: 'go.mod' | |
| - name: Run verify scripts | |
| run: make verify | |
| - name: Checking for broken Markdown links for main branch | |
| uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| with: | |
| folder-path: './docs' | |
| file-path: './README.md, ./CHANGELOG.md, ./CONTRIBUTING.md, ./GOVERNANCE.md, ./MAINTAINERS.md, ./ROADMAP.md, ./SECURITY.md' | |
| config-file: 'hack/.md_links_config.json' | |
| - name: Markdownlint | |
| run: | | |
| sudo npm install -g [email protected] | |
| make markdownlint |