wow-actions / spell-checker Goto Github PK

Expected Behavior

Spell checking should be performed on file README.md

Current Behavior

There is an HTTP Error returned instead

Possible Solution

Can this be related to this issue octokit/rest.js#32 ? It seems octokit was updated after you published this action

Steps To Reproduce

1. Create a job with a step that invokes the github action
2. Modify a markdown file
3. Push to repo

<!-- Provide a log message if relevant -->

Additional Context

Your Environment

We have a github action that only runs if the changes are only markdown files. We want to spell check these files. I am testing this on a branch and only made changes to the readme file. Basically added "wong wods foget" to the file to see if the spell checker could catch them.

• x6: [e.g. 1.0.0]
• OS: [e.g. macOS Sierra 10.12.3]
• Browser: [e.g. chrome 78.0.3904.108]
  This is my yaml:

name: Check Documentation
on:
  push:
    paths:
    - '**.md'
defaults:
  run:
    shell: bash
#permissions: {}
jobs:
  check-md-only:
    name: This job was triggered
    runs-on: ubuntu-latest
    outputs:
      md-only: ${{ steps.test-md-only.outputs.md-only }}
    permissions:
        contents: read
    steps:
    - name: Checkout
      uses: actions/checkout@v3
      with:
        fetch-depth: 2 # required to compare HEAD^
    - run: git diff --name-only HEAD^..HEAD
    - name: Test MD only
      id: test-md-only
      run: >-
        [ -z "$(git diff --name-only HEAD^..HEAD | grep -ve "\.md$")" ] &&
        echo "md-only=${{toJSON(true)}}" >> $GITHUB_OUTPUT ||
        echo "md-only=${{toJSON(false)}}" >> $GITHUB_OUTPUT
  build:
    name: Run if only MD files
    needs: ['check-md-only']
    runs-on: ubuntu-latest
    if: ${{ fromJSON(needs.check-md-only.outputs.md-only) == true }}
    steps:
    - run: echo ran
    - name: Spell Check
      uses: wow-actions/spell-checker@v1
      with:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         include: |
            **/*.md

Expected Behavior

When the action is run, it always returns success, and in the description it explains if it was Good Spelling or Perfect Spelling. It would be convenient to be able to use the output for the user to determine potential next steps, for example, if they want to fail the job.

Possible Solution

Adding outputs to the action.yml and then add at the end of the run the instructions to core.setOuput ...

Additional Context