Add usage to readme and test image

.github/workflows/build-docker.yaml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - "v*"
   pull_request:
     branches:
       - main

.github/workflows/test.yaml

@@ -1,4 +1,5 @@
-on: [push]
+on:
+  - workflow_dispatch
 
 jobs:
   spell-check:
@@ -10,7 +11,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Spell check action
-        uses: ./ # Uses an action in the root directory
+        uses: ./ # Uses the action in the root directory
         id: spell
       # Use the output from the `spell check` step
       - name: Get the number of errors

README.md

@@ -1,6 +1,51 @@
 # spellcheck
 
-This repository contains a Docker image with the [R `spelling` package](https://cran.r-project.org/web/packages/spelling/index.html) installed.
-The role of this repository is to facilitate spell checking actions across `AlexsLemonade` repositories.
+This repository contains a GitHub action to run the [R `spelling` package](https://cran.r-project.org/web/packages/spelling/index.html).
+The role of this action is to facilitate spell checking actions across `AlexsLemonade` repositories.
 
-speeling
+Currently the action will only spell check text in Rmd and md files
+
+## Usage
+
+To use this action, create a `.github/workflows/spellcheck.yml` file in your repository with the following contents (modified to fit your exact needs):
+
+```yaml
+name: Check Spelling
+on:
+  pull_request:
+    branches:
+     - main
+
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+    name: Spell check files
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Spell check action
+        uses: alexslemonade/spellcheck
+        id: spell
+        with:
+          dictionary: components/dictionary.txt
+
+      - name: Upload spell check errors
+        uses: actions/upload-artifact@v4
+        with:
+          name: spell_check_errors
+          path: spell_check_errors.tsv
+
+      - name: Fail if there are spelling errors
+        if: steps.spell.outputs.error_count > 0
+        run: |
+          echo "There were ${{ steps.spell.outputs.error_count }} errors"
+          exit 1
+```
+
+Note that the `dictionary` input to the spell check step is optional and defaults to `components/dictionary.txt`.
+If you want to use a different dictionary, you can specify the path to the dictionary file in your repository.
+
+You can also specify specific files to spell check using the `files` input to the `alexslemonade/spellcheck` step.
+Globs should work as expected.

action.yaml

@@ -1,20 +1,20 @@
 # action.yml
-name: 'R spell check'
-description: 'Spell check R, Rmd and md files'
+name: "R spell check"
+description: "Spell check R, Rmd and md files"
 inputs:
-  dictionary:  # id of input
-    description: 'Dictionary file path'
+  dictionary: # id of input
+    description: "Dictionary file path"
     required: true
-    default: 'components/dictionary.txt'
+    default: "components/dictionary.txt"
   files:
     description: Glob of files to check
     required: false
 outputs:
   error_count:
     description: The number of spelling errors
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: "docker"
+  image: ghcr.io/alexslemonade/spellcheck:edge
   args:
-    - ${{ inputs.dictionary }}
+    - ${{ inputs.dictionary || '/dev/null'  }}
     - ${{ inputs.files }}

spell-check.R

@@ -12,7 +12,7 @@ dict_file <- arguments[1]
 
 arguments <- arguments[-1]
 # if there are arguments, check those files, otherwise check all markdown & rmd files
-if (length(arguments) > 1) {
+if (length(arguments) > 0) {
   files <- arguments[grepl(file_pattern, arguments)]
 } else {
   files <- list.files(pattern = file_pattern, recursive = TRUE, full.names = TRUE)