rojopolis / spellcheck-github-actions

Spell check action
MIT License
132 stars 38 forks source link

Spelling check failed but GitHub Action succeed #166

Closed nlhomme closed 1 year ago

nlhomme commented 1 year ago

Hello,

This is my configuration inside the folder .github/workflows:

image

.spelling_action.yml

name: Spellcheck Action
on: push

jobs:
  build:
    name: Spellcheck
    runs-on: ubuntu-latest
    steps:
    # The checkout step
    - uses: actions/checkout@v3
    - uses: rojopolis/spellcheck-github-actions@v0
      name: Spellcheck
      with:
        config_path: .github/workflows/.spellcheck.yml
        output_file: spellcheck-output.txt

.spellcheck.yml

matrix:
- name: Markdown
  aspell:
    lang: fr
    d: fr_FR
  dictionary:
    encoding: utf-8
    wordlists:
    - .github/workflows/.wordlist.txt
  pipeline:
  - pyspelling.filters.markdown:
  - pyspelling.filters.html:
      comments: false
      ignores:
      - code
      - pre
  sources:
  - '_posts/*.md'
  default_encoding: utf-8

.wordlist.txt

CD-ROM

When I run a GitHub Action, the logs says that spell check has failed:

(...)
Misspelled words:
<htmlcontent> _posts/2023-07-04-Bujur-le-monde.md: html>body>p
--------------------------------------------------------------------------------
LHOMME
Nicolas
height
width
--------------------------------------------------------------------------------

!!!Spelling check failed!!!

But in the end, the action is marked as a success image

Can you help me find what's wrong?

Regards

jonasbn commented 1 year ago

Hi @nlhomme

I will have a look. It this a public repository?

nlhomme commented 1 year ago

Hello @jonasbn,

It's a private one, but I just sent you an invite as a collaborator. If you have to do some commit please do it in the "gh-worflow" ;)

Of course, I will put here a comment telling what is the solution for everybody.

Regards

jonasbn commented 1 year ago

Hi @nlhomme

I made a minor configuration change to your repository, now it fails as expected.

There seem to be a error in the action, where the specification of a file artifact obstructs proper status reporting.

I will treat your issue as a bug report and will look into getting this addressed.

jonasbn commented 1 year ago

A public demonstration of the bug is available here:

nlhomme commented 1 year ago

I confirm that it's now working as intended, thank you for your time and your actions! :)

I also moved the file .github/workflows/.spellcheck.yml to .github/.spellcheck.yml to avoid having a second (and useless) Github Action.