Fix honoring skip phrases #1088
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: Spelling 🆎 | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| - ready_for_review | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| workflow_call: | |
| secrets: | |
| REPO_GITHUB_TOKEN: | |
| description: Github token with write access to the repo | |
| required: false | |
| inputs: | |
| package-subdirectory: | |
| description: Subdirectory in the repository, where the R package is located. | |
| required: false | |
| type: string | |
| default: "." | |
| exclude: | |
| description: Comma separated list of files or folders to exclude from spellcheck. Accepts globs. | |
| type: string | |
| default: "inst/extdata/*" | |
| required: false | |
| concurrency: | |
| group: spelling-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| # check-skip-instructions: | |
| # name: Check skip instructions ⚙️ | |
| # runs-on: ubuntu-latest | |
| # outputs: | |
| # head-commit-message: ${{ steps.get-commit-message.outputs.head_commit_message }} | |
| # steps: | |
| # - name: Checkout Code 🛎 | |
| # uses: actions/checkout@v4 | |
| # with: | |
| # fetch-depth: 1 | |
| # ref: ${{ github.event.pull_request.head.sha }} | |
| # - name: Get commit message 💬 | |
| # id: get-commit-message | |
| # run: | | |
| # echo "head_commit_message=$(git show -s --format=%B | tr '\r\n' ' ' | tr '\n' ' ')" >> $GITHUB_OUTPUT | |
| # echo "head_commit_message = $(git show -s --format=%B | tr '\r\n' ' ' | tr '\n' ' ')" | |
| # shell: bash | |
| spelling: | |
| name: Check spelling 🔠 | |
| runs-on: ubuntu-latest | |
| # needs: check-skip-instructions | |
| if: > | |
| github.event.pull_request.draft == false | |
| # if: > | |
| # !contains(needs.check-skip-instructions.outputs.head-commit-message, '[skip spelling]') | |
| # && github.event.pull_request.draft == false | |
| container: | |
| image: ghcr.io/insightsengineering/rstudio:latest | |
| steps: | |
| # - name: Debug | |
| # run: | | |
| # echo "skip_spelling = ${{ contains(needs.check-skip-instructions.outputs.head-commit-message, '[skip spelling]') }}" | |
| # echo "head_commit_message = ${{ needs.check-skip-instructions.outputs.head-commit-message }}" | |
| - name: Setup token 🔑 | |
| id: github-token | |
| run: | | |
| if [ "${{ secrets.REPO_GITHUB_TOKEN }}" == "" ]; then | |
| echo "REPO_GITHUB_TOKEN is empty. Substituting it with GITHUB_TOKEN." | |
| echo "token=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_OUTPUT | |
| else | |
| echo "Using REPO_GITHUB_TOKEN." | |
| echo "token=${{ secrets.REPO_GITHUB_TOKEN }}" >> $GITHUB_OUTPUT | |
| fi | |
| shell: bash | |
| - name: Checkout Code 🛎 | |
| uses: actions/checkout@v4 | |
| with: | |
| token: ${{ steps.github-token.outputs.token }} | |
| - name: Get commit message 💬 | |
| run: | | |
| git config --global --add safe.directory $(pwd) | |
| export head_commit_message="$(git show -s --format=%B | tr '\r\n' ' ' | tr '\n' ' ')" | |
| echo "head_commit_message = $(git show -s --format=%B | tr '\r\n' ' ' | tr '\n' ' ')" | |
| if [[ $head_commit_message == *"[skip spelling]"* ]]; then | |
| echo "Skip instruction detected." | |
| exit 0 | |
| fi | |
| shell: bash | |
| - name: Normalize variables 📏 | |
| run: | | |
| package_subdirectory_input="${{ inputs.package-subdirectory }}" | |
| echo "package_subdirectory=${package_subdirectory_input:-.}" >> $GITHUB_ENV | |
| shell: bash | |
| - name: Run Spellcheck 👟 | |
| uses: insightsengineering/r-spellcheck-action@v2 | |
| with: | |
| exclude: ${{ inputs.exclude }} | |
| path: ${{ env.package_subdirectory }} | |
| - name: Clean up WORDLIST 🧼 | |
| if: github.event_name == 'push' | |
| run: | | |
| x <- readLines('inst/WORDLIST') | |
| file.remove('inst/WORDLIST') | |
| spelling::update_wordlist(confirm = FALSE) | |
| y <- readLines('inst/WORDLIST') | |
| if (length(setdiff(y, x)) == 0 && length(setdiff(x, y)) > 0) { | |
| message("Unnecessary entries on WORDLIST:") | |
| message(cat(setdiff(x, y), sep='\n')) | |
| } | |
| shell: Rscript {0} | |
| - name: Checkout to main 🛎 | |
| if: github.event_name == 'push' | |
| run: | | |
| git fetch origin main | |
| git checkout main | |
| git pull origin main | |
| - name: Set file pattern to commit ⚙️ | |
| if: github.event_name == 'push' | |
| id: file-pattern | |
| run: | | |
| if [[ "${{ inputs.package-subdirectory }}" == "." ]]; then | |
| FILE_PATTERN="inst/WORDLIST" | |
| else | |
| FILE_PATTERN="${{ inputs.package-subdirectory }}/inst/WORDLIST" | |
| fi | |
| echo "file-pattern=$FILE_PATTERN" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - name: Commit and push changes 📌 | |
| if: github.event_name == 'push' | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| with: | |
| commit_message: "[skip ci] Update WORDLIST" | |
| file_pattern: "${{ steps.file-pattern.outputs.file-pattern }}" | |
| commit_user_name: github-actions | |
| commit_user_email: >- | |
| 41898282+github-actions[bot]@users.noreply.github.com | |
| continue-on-error: true |