diff --git a/.github/workflows/docs-spelling-check.yaml b/.github/workflows/docs-spelling-check.yaml new file mode 100644 index 0000000000..f5533571e6 --- /dev/null +++ b/.github/workflows/docs-spelling-check.yaml @@ -0,0 +1,48 @@ +# Copyright (c) 2024 Willem 'Jip' Wijnia +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +name: Documentation - Verify spelling + +on: + push: + branches: ["develop"] + paths: ["docs/**"] + + pull_request: + paths: ["docs/**"] + + workflow_dispatch: + +jobs: + verify: + name: Verify spelling + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + sparse-checkout: | + docs + + - name: Check spelling + uses: check-spelling/check-spelling@main + with: + checkout: false + \ No newline at end of file