Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling check failed but GitHub Action succeed #166

Closed
nlhomme opened this issue Jul 6, 2023 · 5 comments
Closed

Spelling check failed but GitHub Action succeed #166

nlhomme opened this issue Jul 6, 2023 · 5 comments
Assignees
Labels
bug Something isn't working

Comments

@nlhomme
Copy link

nlhomme commented Jul 6, 2023

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 jonasbn self-assigned this Jul 6, 2023
@jonasbn
Copy link
Collaborator

jonasbn commented Jul 6, 2023

Hi @nlhomme

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

@nlhomme
Copy link
Author

nlhomme commented Jul 7, 2023

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

@nlhomme nlhomme changed the title Spelling check failed but GitHub Action succed Spelling check failed but GitHub Action succeed Jul 7, 2023
@jonasbn
Copy link
Collaborator

jonasbn commented Jul 9, 2023

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 jonasbn added the bug Something isn't working label Jul 9, 2023
@jonasbn
Copy link
Collaborator

jonasbn commented Jul 9, 2023

A public demonstration of the bug is available here:

@nlhomme
Copy link
Author

nlhomme commented Jul 9, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants