ci: use markdownlint to enforce mkdocs compatibility #20890
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
| name: Codespell | |
| on: | |
| push: | |
| tags: | |
| - v* | |
| branches: | |
| - master | |
| - release-* | |
| pull_request: | |
| branches: | |
| - master | |
| - release-* | |
| # cancel the in-progress workflow when PR is refreshed. | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| codespell: | |
| name: codespell | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: codespell | |
| uses: codespell-project/actions-codespell@master | |
| with: | |
| # LICENSE: skip file because codespell wants to flag complies, which we may want to flag | |
| # in other places, so ignore the file itself assuming it is correct | |
| # crds.yaml, resources.yaml: CRD files are fully generated from content we control (should | |
| # be flagged elsewhere) and content we don't control (can't fix easily), so ignore | |
| skip: .git,*.png,*.jpg,*.svg,*.sum,./LICENSE,./deploy/examples/crds.yaml,./deploy/charts/rook-ceph/templates/resources.yaml | |
| # aks: Amazon Kubernetes Service | |
| # keyserver: flag to apt-key | |
| # atleast: codespell wants to flag any 'AtLeast' method | |
| # ser, ist: MIME types in pkg/operator/ceph/object/mime.go | |
| # ba: daemon ID test in pkg/operator/k8sutil/name_test.go | |
| # iam: Identity and Access Management, e.g., AWS IAM | |
| # te: udev persistent naming test in pkg/daemon/ceph/osd/daemon_test.go | |
| # parm: modinfo parameter | |
| # assigment: inherited from K8s TopologySpreadConstraints dependency | |
| # ro, RO: means read-only | |
| ignore_words_list: aks,keyserver,atleast,ser,ist,ba,iam,te,parm,assigment,ro,RO | |
| check_filenames: true | |
| check_hidden: true | |
| misspell: | |
| name: misspell | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: misspell | |
| uses: reviewdog/action-misspell@v1 |