spellcheck.yaml

# ------------------------------------------------------------
# Copyright 2023 The Radius Authors.
#
# 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
#    
#     http://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: Spellcheck

on:
  pull_request:
    branches:
      - main

env:
  ACTION_LINK: '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'

concurrency:
  group: spellcheck-${{ github.ref }}-${{ github.event.pull_request.number || github.sha }}

jobs:
  spellcheck:
    name: Spellcheck
    runs-on: ubuntu-latest
    steps:
    - name: Checkout design-notes repo
      uses: actions/checkout@v3
    - name: Spellcheck
      uses: rojopolis/spellcheck-github-actions@0.33.0
      with:
        config_path: .github/config/.pyspelling.yml
    - name: Post GitHub workkflow output on failure
      if: failure()
      run: |
        echo "## :x: Spellcheck Failed" >> $GITHUB_STEP_SUMMARY
        echo "There are spelling errors in your PR. Visit [the workflow output](${{ env.ACTION_LINK }}) to see what words are failing." >> $GITHUB_STEP_SUMMARY
        echo "### Adding new words" >> $GITHUB_STEP_SUMMARY
        echo "You can add new custom words to [.github/config/en-custom.txt](https://github.com/radius-project/design-notes/blob/main/.github/config/en-custom.txt)." >> $GITHUB_STEP_SUMMARY
    - name: Post GitHub workflow output on success
      run: |
        echo "## :white_check_mark: Spellcheck Passed" >> $GITHUB_STEP_SUMMARY
        echo "There are no spelling errors in your PR." >> $GITHUB_STEP_SUMMARY
    - name: Post GitHub comment on failure
      if: failure()
      uses: marocchino/sticky-pull-request-comment@v2
      with:
        header: spellcheck
        recreate: true
        message: |
          ## :x: Spellcheck Failed
          There are spelling errors in your PR. Visit [the workflow output](${{ env.ACTION_LINK }}) to see what words are failing.
          ### Adding new words
          You can add new custom words to [.github/config/en-custom.txt](https://github.com/radius-project/design-notes/blob/main/.github/config/en-custom.txt).
    - name: Clear GitHub comment on success
      uses: marocchino/sticky-pull-request-comment@v2
      continue-on-error: true
      with:
        header: spellcheck
        delete: true