spelling.yaml

---
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:
  spelling:
    name: Check spelling 🔠
    runs-on: ubuntu-latest
    if: >
      !contains(github.event.commits[0].message, '[skip spelling]')
        && github.event.pull_request.draft == false
    container:
      image: ghcr.io/insightsengineering/rstudio:latest

    steps:
      - 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: Get branch names 🌿
        id: branch-name
        uses: tj-actions/branch-names@v7

      - name: Checkout repo (PR) 🛎
        uses: actions/checkout@v4.1.1
        if: github.event_name == 'pull_request'
        with:
          ref: ${{ steps.branch-name.outputs.head_ref_branch }}
          repository: ${{ github.event.pull_request.head.repo.full_name }}
          fetch-depth: 1
          token: ${{ steps.github-token.outputs.token }}

      - name: Checkout repo 🛎
        uses: actions/checkout@v4.1.1
        if: github.event_name != 'pull_request'
        with:
          ref: ${{ steps.branch-name.outputs.head_ref_branch }}
          token: ${{ steps.github-token.outputs.token }}

      - name: Check 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 = $head_commit_message"
          if [[ $head_commit_message == *"$SKIP_INSTRUCTION"* ]]; then
            echo "Skip instruction detected - cancelling the workflow."
            exit 1
          fi
        shell: bash
        env:
          SKIP_INSTRUCTION: "[skip spelling]"

      - 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 config --global --add safe.directory $(pwd)
          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