618 templates action #459
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: | |
| workflow_dispatch: | |
| workflow_call: | |
| inputs: | |
| r-version: | |
| description: 'The version of R to use' | |
| default: '4.1' | |
| required: false | |
| type: string | |
| exclude: | |
| description: 'List of paths to exclude (comma seperated list)' | |
| default: '' | |
| required: false | |
| type: string | |
| push: | |
| branches: | |
| - main | |
| - devel | |
| - pre-release | |
| pull_request: | |
| branches: | |
| - main | |
| - devel | |
| - pre-release | |
| concurrency: | |
| group: spelling-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| get_r_version: | |
| name: Get R version | |
| runs-on: ubuntu-latest | |
| if: > | |
| !contains(github.event.commits[0].message, '[skip spellcheck]') | |
| outputs: | |
| r-version: ${{ steps.normalizer.outputs.R_VERSION }} | |
| steps: | |
| - name: Normalize inputs | |
| id: normalizer | |
| run: | | |
| R_VERSION="${{ inputs.r-version }}" | |
| if [ "$R_VERSION" == "" ] | |
| then { | |
| R_VERSION="4.1" | |
| } | |
| fi | |
| echo "R_VERSION=$R_VERSION" >> $GITHUB_OUTPUT | |
| shell: bash | |
| roxygen: | |
| name: Spellcheck | |
| runs-on: ubuntu-latest | |
| container: | |
| image: "ghcr.io/pharmaverse/admiralci-${{needs.get_r_version.outputs.r-version}}:latest" | |
| env: | |
| GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
| if: > | |
| !contains(github.event.commits[0].message, '[skip spellcheck]') | |
| needs: get_r_version | |
| steps: | |
| ##################### BEGIN boilerplate steps ##################### | |
| - name: Get branch names | |
| id: branch-name | |
| uses: tj-actions/[email protected] | |
| - name: Checkout repo (PR) 🛎 | |
| uses: actions/checkout@v3 | |
| if: github.event_name == 'pull_request' | |
| with: | |
| ref: ${{ steps.branch-name.outputs.head_ref_branch }} | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| if: github.event_name != 'pull_request' | |
| with: | |
| ref: ${{ steps.branch-name.outputs.head_ref_branch }} | |
| - name: Restore cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.staged.dependencies | |
| key: staged-deps | |
| - name: Run Staged dependencies | |
| uses: insightsengineering/staged-dependencies-action@v1 | |
| with: | |
| run-system-dependencies: false | |
| renv-restore: false | |
| enable-check: false | |
| env: | |
| GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
| ##################### END boilerplate steps ##################### | |
| - name: Run Spellcheck | |
| uses: insightsengineering/r-spellcheck-action@v3 | |
| with: | |
| additional_options: "" | |
| exclude: "${{ inputs.exclude }}" |