rojopolis / spellcheck-github-actions Goto Github PK

View Code? Open in Web Editor NEW

131.0 131.0 36.0 311 KB

Spell check action

License: MIT License

Dockerfile 24.30% Shell 75.70%

spellcheck-github-actions's People

Contributors

Stargazers

Watchers

spellcheck-github-actions's Issues

Evaluate wordlist detection enhancement

Hi @edumco

Thanks for the elaborate feedback. I have compiled your comments to this list:

Evaluate wordlist detection enhancement

Originally posted by @jonasbn in #12 (comment)

Support for french

Hi,
Is it possible to add support for french language?
Thanks!

Clarify how Ignore code blocks in Markdown

Discussed in #99

^{Originally posted by arivictor June 8, 2022}
Hi,

I'm looking to use your action in my pipeline. I'm running it over my markdown docs, its catching spelling mistakes very well but its also picking up issues in the example code blocks in the markdown files. To reduce the noise, is it possible to ignore the code blocks?

My config:

matrix:
- name: markdown
  pipeline:
  - pyspelling.filters.text
  sources:
  - '**/*.md'
  default_encoding: utf-8

I'm looking at the example configs from PySpell and it has this:

matrix:
- name: python
  sources:
  - pyspelling/**/*.py
  aspell:
    lang: en
    d: en_US
  pipeline:
  - pyspelling.filters.python:
      strings: false
      comments: false

Is there a similar boolean toggle for markdown to ignore code blocks?

Ty!

Multi-stage build of Docker image has issues with aspell installation

Currently this is patched via PR #56 addressing issue #55.

But the problem is still there and something in the multi-stage build does not work as expected.

Error after bumping from 13 to 19

Hello there. I am experiencing the following error after bumping from 13 to 19, can you help?

Using pyspelling on configuration outlined in >.spellcheck.yml<
Checking files matching specified outlined in >.spellcheck.yml<
----------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/local/bin/pyspelling", line 8, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.10/site-packages/pyspelling/__main__.py", line 30, in main
    return run(
  File "/usr/local/lib/python3.10/site-packages/pyspelling/__main__.py", line 55, in run
    for results in spellcheck(
  File "/usr/local/lib/python3.10/site-packages/pyspelling/__init__.py", line 673, in spellcheck
    for result in spellchecker.run_task(task, source_patterns=sources):
  File "/usr/local/lib/python3.10/site-packages/pyspelling/__init__.py", line 311, in run_task
    self._build_pipeline(task)
  File "/usr/local/lib/python3.10/site-packages/pyspelling/__init__.py", line 255, in _build_pipeline
    raise ValueError(STEP_ERROR.format(str(step)))
ValueError: Pipline step in unexpected format: {'pyspelling.filters.python': None, 'comments': True, 'docstrings': True, 'group_comments': True, 'decode_escapes': True, 'strings': False, 'string_types': 'fu'}

Each pipeline step should be in the form {key: options: {}} not {key: {}, key2: {}}

Error: Files in repository contain spelling errors

Here is my config file:
https://github.com/gergelytakacs/AutomationShield/actions/runs/1611803103/workflow

Using tags for release management

You may want to use this approach to releases so users won't have to update their action as often:

Using tags for release management

Actions-R-Us/actions-tagger

Document ability to extend the Markdown parsing

Resources:

Release 0.8.0 support the above extensions, this has to be properly documented, ref: #28

Spelling check failed but GitHub Action succeed

Hello,

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

.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

Can you help me find what's wrong?

Regards

Problem with UTF-8 character in wordlist file

I am observing an issue with the action in the repository jonasbn/perl-task-date-holidays

The word: Rezić is reported as a spelling mistake even when listed in the word list file (.wordslist.txt).

REF: relevant jonasbn/perl-task-date-holidays@150683d of jonasbn/perl-task-date-holidays/.wordlist.txt as head has been altered.

This is the configuration:

matrix:
- name: Markdown
  aspell:
    lang: en
    ignore-case: true
  dictionary:
    wordlists:
    - .wordlist.txt
    encoding: utf-8
  pipeline:
  - pyspelling.filters.markdown:
  - pyspelling.filters.html:
      comments: false
      ignores:
      - code
      - pre
  sources:
  - '**/*.md'
  default_encoding: utf-8

REF: perl-task-date-holidays/.spellcheck.yaml

Exclude directory from spell checker

It would be great if we could exclude a directory from the spell checker. I've tried using the PySpelling configuration to do this, but it doesn't seem to work.

Thanks!

Action fails: FileNotFoundError: [Errno 2] No such file or directory: 'wordlist.txt'

Fail to check project: https://github.com/edumco/Algorithms-Explanation

Log attached: logs_1.zip

markdown: 'NoneType' object has no attribute 'end'

I'm just trying to do simple spellchecking, but I get an incomprehensible error that stops that whole thing... after I worked and worked to get a wordlist together:

ERROR: docs/users/cli-usage.md -- 'NoneType' object has no attribute 'end'

You can see the run at https://github.com/drud/ddev/runs/1666052073?check_suite_focus=true

The code is all at https://github.com/rfay/ddev/tree/20210107_spellcheck

The file it's crashing on is https://github.com/rfay/ddev/blob/20210107_spellcheck/docs/users/cli-usage.md

I imagine this is a problem with PySpelling, but I'm sure you don't want users to encounter obscure errors like this.

cp: cannot stat '/wordlist.txt': No such file or directory

Spell check failed with the following error:

Run rojopolis/[email protected]
/usr/bin/docker run ...<concealed>...
cp: cannot stat '/wordlist.txt': No such file or directory
['aspell', '--lang', 'en', '--encoding', 'utf-8', 'create', 'master', '/github/workspace/wordlist.dic']
Current wordlist: 'wordlist.txt'
Problem compiling dictionary. Check the binary path and options.
Traceback (most recent call last):
  File "/usr/local/bin/pyspelling", line 8, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__main__.py", line 34, in main
    debug=args.debug
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__main__.py", line 59, in run
    debug=debug
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 662, in spellcheck
    for result in spellchecker.run_task(task, source_patterns=sources):
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 298, in run_task
    personal_dict = self.setup_dictionary(task)
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 340, in setup_dictionary
    output
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 370, in compile_dictionary
    with open(wordlist, 'rb') as src:
FileNotFoundError: [Errno 2] No such file or directory: 'wordlist.txt'
##[error]Docker run failed with exit code 1

Ignore markdown regions with code hints

Is it possible to tell spellcheck to ignore the markdown hinted areas for language?

For example, if I have

```bash
kubectl get nodes
```

Can it just not spellcheck that bash statement? I have lots of awscli or kubectl or curl commands and right now that means 800+ misspelled words

Foreign languages

Hi rojopolis,

thanks for the cool implementation, very helpful to monitor a project! If I want to use another language, do I need to install the dictionary separately beforehand? A test for

aspell:
    lang: de_DE # or de

failed with

ERROR: README.md: html>body>h1 -- Runtime Error: Error: No word lists can be found for the language "de_DE".

Many thanks!

Sebastian

Investigate migration to Alpine over Debian

This issue was spun of the below list.

This issue is aimed at addressing the migration to Alpine from Debian in the Docker image.

Hi @edumco

Thanks for the elaborate feedback. I have compiled your comments to this list:

Evaluate option for using Alpine based Python image

Originally posted by @jonasbn in #12 (comment)

How to apply spellcheck action on all markdown files of the repo ?

Hello...
I have successfuly integrate this action workflow in my project and It seems to be working very well 🚀!

I have several markdown files in different directories in my repository and I want to apply this action on all of them.
How do I go about it ?
What I mean, is having something like...

- source-files: README.md notes/*.md docs/*.md

Support ignoring files

From looking at the documentation, it looks like you can specify files to check, but you can't specify files to exclude.

I have dozens of files I do want to check, but only a handful I want to ignore.

With DavidAnson/markdownlint-cli2-action for example, I can specify some globs:

- name: Lint Markdown files
  uses: DavidAnson/markdownlint-cli2-action@v13
  with:
    globs: |
      **/*.md
      !CHANGELOG.md
      !**/BenchmarkDotNet.Artifacts/**/*.md

It would be nice if similar functionality were supported so I don't need to list every file individually in the case I want to only ignore one or more files.

Latest container version failing on runners due to architecture mismatch

@jonasbn it appears that the latest version of the spellcheck container has been published as arm64 rather than amd64 or for multiple platforms. This issue is causing the action to fail on the GitHub Actions runners.

Can you either rollback the tags or publish an image for amd64?

Investigate possibility of suppressing HTML tags in output

Hi @edumco

Thanks for the elaborate feedback. I have compiled your comments to this list:

Investigate possibility to suppress HTML output from PySpelling

Originally posted by @jonasbn in #12 (comment)

Marketplace still using 0.2.0 which has wordlist.txt issue.

Can you bump the marketplace latest to 0.3.0 so people don't hit the wordlist.txt issue (issue #1) please?

ValueError: Pipline step in unexpected format: {'pyspelling.filters.html': None, 'comments': False, 'ignores': ['code', 'pre']}

I tried to follow the example below, but I'm getting some errors.

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

Here is the error I'm getting:

Traceback (most recent call last):
  File "/usr/local/bin/pyspelling", line 8, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.9/site-packages/pyspelling/__main__.py", line 30, in main
    return run(
  File "/usr/local/lib/python3.9/site-packages/pyspelling/__main__.py", line 55, in run
    for results in spellcheck(
  File "/usr/local/lib/python3.9/site-packages/pyspelling/__init__.py", line 673, in spellcheck
    for result in spellchecker.run_task(task, source_patterns=sources):
  File "/usr/local/lib/python3.9/site-packages/pyspelling/__init__.py", line 311, in run_task
    self._build_pipeline(task)
  File "/usr/local/lib/python3.9/site-packages/pyspelling/__init__.py", line 255, in _build_pipeline
    raise ValueError(STEP_ERROR.format(str(step)))
ValueError: Pipline step in unexpected format: {'pyspelling.filters.html': None, 'comments': False, 'ignores': ['code', 'pre']}

I was able to resolve it by removing the pipeline step. Is this a known issue? This is a recent issue as I have used this action for some time now.

PySpelling output artifact?

First of all, thanks for the great work with this action! 👏

This might be a tricky one, but would it be possible to offer the possibility of dumping the output from pyspelling to a file (in addition to what we see in the workflow log), to allow uploading it as artifact in workflows using this action?

Ignore spell check in hyperlinks

Please is there a way how to ignore spell check of hyperlinks?
link text

can you add a feature that ignores specific sections in an md file?

I have UIDs in some of our codeblocks. I do not want to ignore codeblocks altogether. Is it possible to ignore specific sections of text?

Error: Unable to find or load pyspelling configuration from spellcheck.yaml

Investigate possible issue with error count PySpelling

Hi @edumco

Thanks for the elaborate feedback. I have compiled your comments to this list:

Investigate possible issue with error count PySpelling

Originally posted by @jonasbn in #12 (comment)

Action uses non-standard configuration location

In order to ensure good developer experience, we want to allow developers to run the same commands on their workstations as is run by the CI.

Unfortunately this is not possible with spellcheck-github-actions, as it relies on .spellcheck.yaml whereas pyspellcheck relies on .pyspelling.yaml.

This means that we either cater to the github action and tell our developers to run pyspelling with the -c flag set, or we have to change the config for the action to explicitly include .pyspelling.yaml.

Given that the PySpelling default config location is .pyspelling.yaml it would be great if this file was also added to the list of default configuration files.

If people are open to this change, I'm more than happy to create the PR to fix it! :)

The use of file artifacts suppresses Workflow runs that fail

When a the use of a file artifact is specified the workflow always succeeds and errors are suppressed.

A public demonstration of the bug is available here:

https://github.com/jonasbn/til/actions/runs/5501665796/jobs/10025408816

This originates from #166

Implement automation of build and release process

🔤 User Story

As a maintainer
I can build a Docker image automatically and have it uploaded to a container registry
so that I can make sure that it is built on a compatible platform

ℹ️ Notes

Issue #79 demonstrated that it is better to have a automated build and release process to eliminate human error, in this case the human error was that the Docker image was build on a incompatible architecuture
Container registries could be one of:
- DockerHub (currently uses)
- GitHub Container Registry, ghcr for short
I is expected that at secret token is requested by the container registry chosen
- This has tp be configured for the GitHub repository, this can be problematic since the repository is owned by somebody else than the current maintainer
Automated build is already in place, see: docker-build.yml

🆗 Acceptance Criteria

I can build automatically
I can push to a container registry
the built image is compatible with GitHub Actions

➡️ Resources and References

How spell of latest commit message ?

Hello! I try use you github action for spell of commit message.
But it don`t spell commit message.
Please add spell of latest commit message. Thanks!

Silent mode

Would be nice to have a silent mode so it doesn't break CI for some files or branches

We could have an breaking action for PR and a silent for the branches

What do you think about it?

Help: Actions in this workflow must be: within a repository that belongs to your Enterprise account, created by GitHub, or verified in the GitHub Marketplace.

Hello ,
We got this error when try to use the spellcheck github actions in our enterprise github repo:
[Error: .github#L1]
rojopolis/[email protected] is not allowed to be used in xxxxrepo. Actions in this workflow must be: within a repository that belongs to your Enterprise account, created by GitHub, or verified in the GitHub Marketplace.

Could you please let me know if there are some solutions?
thanks.

aspell disappears from build doing multi-stage build introduced in 0.15.0

Verification Scope Restriction

The spelling verification reviews all repository files, wasting time on unchanged files. Is it possible to limit checks to files in a specific pull request, focusing only on new or modified content?

Adding a "changed_only: true" flag could be a viable solution to this issue.

Failing to build

When attempting to run this, I get the following error-

/bin/sh: apt-get: not found

https://github.com/EsteemedIO/esteemedio.github.io/runs/820756861

Enabling discussions

Ping @rojopolis

Could you enable discussions for this repository? it should be pretty easy, I just do not have the privileges to set it up.

There is a guide here: https://docs.github.com/en/discussions/quickstart#enabling-github-discussions-on-your-repository

Git submodules as wordlist?

How would you use a git submodule as a wordlist, when I try to use it currently It always just returns that the wordlist could not be found.

Paths with spaces in source_files parameter does not work

When files with spaces in paths are supplied to source_files parameter the action does not work as expected.

Partial log:

Run rojopolis/spellcheck-github-actions@0.[2](https://ghe.coxautoinc.com/CMS-PE/Knowledge-Base/runs/402496?check_suite_focus=true#step:5:2)2.1
  with:
    source_files: "Managed Services/Security Monitor/README.md" "Terraform/Development Guide/README.md"
    task_name: Markdown
    config_path: assets/config/.spellcheck.yml
/usr/bin/docker run --name jonasbngithubactionspellcheck0221_70[3](https://<hidden>/Knowledge-Base/runs/402496?check_suite_focus=true#step:5:3)22[5](https://<hidden>/Knowledge-Base/runs/402496?check_suite_focus=true#step:5:5) --label c3f2[6](https://<hidden>/Knowledge-Base/runs/402496?check_suite_focus=true#step:5:6)1 --workdir /github/workspace --rm -e INPUT_SOURCE_FILES -e INPUT_TASK_NAME -e INPUT_CONFIG_PATH -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/actions-runner/_work/_temp/_github_home":"/github/home" -v "/actions-runner/_work/_temp/_github_workflow":"/github/workflow" -v "/actions-runner/_work/_temp/_runner_file_commands":"/github/file_commands" -v "/actions-runner/_work/Knowledge-Base/Knowledge-Base":"/github/workspace" jonasbn/github-action-spellcheck:0.22.1

Using pyspelling on configuration outlined in >assets/config/.spellcheck.yml<
Running task >Markdown<
Checking file >"Managed<
Checking file >Services/Security<
Checking file >Monitor/README.md"<
Checking file >"Terraform/Development<
Checking file >Guide/README.md"<
----------------------------------------------------------------
Spelling check passed :)

PS. Escaping spaces with backslash does not help.

Push image to Docker Hub or GitHub Packages

The image is built on every run.
The process could be sped up significantly by pushing the Dockerfile to Docker Hub (for automatic building) or GitHub packages and then use it from there.

Do you consider this an option?

Ignore casing issues

Is it possible to define a word once in the word list, and allow all casings for it?

how to use for other languages?

I tried to get this action working several weeks ago but failed because it seems that only English is included. Is there any possibility to tell this action to install for example German support? I guess this would require installing additional packages in the docker file, so probably not easy...

spellcheck.yaml is not used

hello,

I defined my own spellcheck.yaml, there are only *.txt pattern

https://github.com/chipitsine/haproxy

however, runner complains it cannot find *.py, I suspect it tries to use its default config

https://github.com/chipitsine/haproxy/runs/446656168?check_suite_focus=true

Make pre-commit hook out of this repository

Hello, I've had a need to add spellchecking to my repo docs. For this purpose I've created my hook definition based on this repository. I think that's probably a small addition that would be welcome and more fitting in this repository directly.

All it takes is properly defined pre-commit-hooks.yml file. Here is sample of what my looks like:

-   id: pyspelling-docker
    name: Pyspelling in docker
    description: Pyspelling with aspell using Dockerfile of github action, based on https://github.com/rojopolis/spellcheck-github-actions
    language: docker_image
    entry: jonasbn/github-action-spellcheck:latest

with readme description of how to configure it:

Define in .pre-commit-config.yaml:

- repo: https://github.com/getindata/py-pre-commit-hooks
  rev: v0.1.3
  hooks:
  - id: pyspelling-docker

What do you think? Do you want PR for this?

Unable to build using base images python:3.11.0-slim-bullseye

The lxml requirement will not build with this newer base image.

python-3.11.0-slim-bullseye ✗ $ docker build -t jonasbn/github-action-spellcheck:latest .
[+] Building 8.3s (11/12)
 => [internal] load build definition from Dockerfile                       0.0s
 => => transferring dockerfile: 964B                                       0.0s
 => [internal] load .dockerignore                                          0.0s
 => => transferring context: 34B                                           0.0s
 => [internal] load metadata for docker.io/library/python:3.11.0-slim-bul  1.6s
 => [auth] library/python:pull token for registry-1.docker.io              0.0s
 => [internal] load build context                                          0.0s
 => => transferring context: 106B                                          0.0s
 => [1/7] FROM docker.io/library/python:3.11.0-slim-bullseye@sha256:f8cc8  0.0s
 => CACHED [2/7] RUN apt-get update && apt-get install -y     aspell aspe  0.0s
 => CACHED [3/7] COPY entrypoint.sh /entrypoint.sh                         0.0s
 => CACHED [4/7] COPY requirements.txt /requirements.txt                   0.0s
 => CACHED [5/7] COPY spellcheck.yaml /spellcheck.yaml                     0.0s
 => ERROR [6/7] RUN pip3 install -r /requirements.txt                      6.7s
------
 > [6/7] RUN pip3 install -r /requirements.txt:
#11 1.237 Collecting backrefs==5.0.1
#11 1.338   Downloading backrefs-5.0.1-py39-none-any.whl (376 kB)
#11 1.405      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 376.3/376.3 kB 5.8 MB/s eta 0:00:00
#11 1.433 Collecting beautifulsoup4==4.9.3
#11 1.449   Downloading beautifulsoup4-4.9.3-py3-none-any.whl (115 kB)
#11 1.463      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.8/115.8 kB 9.4 MB/s eta 0:00:00
#11 1.592 Collecting bracex==2.1.1
#11 1.611   Downloading bracex-2.1.1-py3-none-any.whl (10 kB)
#11 1.636 Collecting html5lib==1.1
#11 1.653   Downloading html5lib-1.1-py2.py3-none-any.whl (112 kB)
#11 1.663      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 112.2/112.2 kB 13.5 MB/s eta 0:00:00
#11 1.795 Collecting lxml==4.9.1
#11 1.817   Downloading lxml-4.9.1.tar.gz (3.4 MB)
#11 2.056      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.4/3.4 MB 14.3 MB/s eta 0:00:00
#11 2.249   Preparing metadata (setup.py): started
#11 2.582   Preparing metadata (setup.py): finished with status 'done'
#11 2.619 Collecting Markdown==3.3.4
#11 2.632   Downloading Markdown-3.3.4-py3-none-any.whl (97 kB)
#11 2.646      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 97.6/97.6 kB 8.2 MB/s eta 0:00:00
#11 2.770 Collecting pymdown-extensions==8.2
#11 2.796   Downloading pymdown_extensions-8.2-py3-none-any.whl (207 kB)
#11 2.820      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 207.7/207.7 kB 9.1 MB/s eta 0:00:00
#11 2.930 Collecting pyspelling==2.8.1
#11 2.951   Downloading pyspelling-2.8.1-py3-none-any.whl (45 kB)
#11 2.958      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45.3/45.3 kB 6.5 MB/s eta 0:00:00
#11 3.000 Collecting PyYAML==5.4.1
#11 3.017   Downloading PyYAML-5.4.1.tar.gz (175 kB)
#11 3.039      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 175.1/175.1 kB 9.1 MB/s eta 0:00:00
#11 3.109   Installing build dependencies: started
#11 4.909   Installing build dependencies: finished with status 'done'
#11 4.910   Getting requirements to build wheel: started
#11 5.329   Getting requirements to build wheel: finished with status 'done'
#11 5.331   Preparing metadata (pyproject.toml): started
#11 5.478   Preparing metadata (pyproject.toml): finished with status 'done'
#11 5.504 Collecting six==1.16.0
#11 5.522   Downloading six-1.16.0-py2.py3-none-any.whl (11 kB)
#11 5.553 Collecting soupsieve==2.2.1
#11 5.572   Downloading soupsieve-2.2.1-py3-none-any.whl (33 kB)
#11 5.689 Collecting wcmatch==8.2
#11 5.703   Downloading wcmatch-8.2-py3-none-any.whl (41 kB)
#11 5.710      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 41.2/41.2 kB 7.8 MB/s eta 0:00:00
#11 5.731 Collecting webencodings==0.5.1
#11 5.747   Downloading webencodings-0.5.1-py2.py3-none-any.whl (11 kB)
#11 5.780 Building wheels for collected packages: lxml, PyYAML
#11 5.780   Building wheel for lxml (setup.py): started
#11 5.933   Building wheel for lxml (setup.py): finished with status 'error'
#11 5.937   error: subprocess-exited-with-error
#11 5.937
#11 5.937   × python setup.py bdist_wheel did not run successfully.
#11 5.937   │ exit code: 1
#11 5.937   ╰─> [84 lines of output]
#11 5.937       Building lxml version 4.9.1.
#11 5.937       Building without Cython.
#11 5.937       Building against libxml2 2.9.10 and libxslt 1.1.34
#11 5.937       running bdist_wheel
#11 5.937       running build
#11 5.937       running build_py
#11 5.937       creating build
#11 5.937       creating build/lib.linux-aarch64-cpython-311
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/_elementpath.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/sax.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/doctestcompare.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/pyclasslookup.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/cssselect.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/usedoctest.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/ElementInclude.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/builder.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/defs.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/diff.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/html5parser.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/_html5builder.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/_setmixin.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/soupparser.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/usedoctest.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/_diffcommand.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/clean.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/builder.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/formfill.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       copying src/lxml/html/ElementSoup.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron
#11 5.937       copying src/lxml/isoschematron/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron
#11 5.937       copying src/lxml/etree.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/etree_api.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/lxml.etree.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/lxml.etree_api.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 5.937       copying src/lxml/includes/c14n.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/relaxng.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/uri.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/xmlparser.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/etreepublic.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/dtdvalid.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/tree.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/xmlerror.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/__init__.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/xinclude.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/config.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/xmlschema.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/htmlparser.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/schematron.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/xpath.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/xslt.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/lxml-version.h -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       copying src/lxml/includes/etree_defs.h -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/rng
#11 5.937       copying src/lxml/isoschematron/resources/rng/iso-schematron.rng -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/rng
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl
#11 5.937       copying src/lxml/isoschematron/resources/xsl/XSD2Schtrn.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl
#11 5.937       copying src/lxml/isoschematron/resources/xsl/RNG2Schtrn.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl
#11 5.937       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_dsdl_include.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_schematron_message.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_schematron_skeleton_for_xslt1.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_abstract_expand.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_svrl_for_xslt1.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/readme.txt -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 5.937       running build_ext
#11 5.937       building 'lxml.etree' extension
#11 5.937       creating build/temp.linux-aarch64-cpython-311
#11 5.937       creating build/temp.linux-aarch64-cpython-311/src
#11 5.937       creating build/temp.linux-aarch64-cpython-311/src/lxml
#11 5.937       gcc -pthread -Wsign-compare -DNDEBUG -g -fwrapv -O3 -Wall -fPIC -DCYTHON_CLINE_IN_TRACEBACK=0 -I/usr/include/libxml2 -Isrc -Isrc/lxml/includes -I/usr/local/include/python3.11 -c src/lxml/etree.c -o build/temp.linux-aarch64-cpython-311/src/lxml/etree.o -w
#11 5.937       Compile failed: command 'gcc' failed: No such file or directory
#11 5.937       creating tmp
#11 5.937       cc -I/usr/include/libxml2 -I/usr/include/libxml2 -c /tmp/xmlXPathInit873kb263.c -o tmp/xmlXPathInit873kb263.o
#11 5.937       *********************************************************************************
#11 5.937       Could not find function xmlCheckVersion in library libxml2. Is libxml2 installed?
#11 5.937       *********************************************************************************
#11 5.937       error: command 'gcc' failed: No such file or directory
#11 5.937       [end of output]
#11 5.937
#11 5.937   note: This error originates from a subprocess, and is likely not a problem with pip.
#11 5.937   ERROR: Failed building wheel for lxml
#11 5.937   Running setup.py clean for lxml
#11 6.061   Building wheel for PyYAML (pyproject.toml): started
#11 6.240   Building wheel for PyYAML (pyproject.toml): finished with status 'done'
#11 6.240   Created wheel for PyYAML: filename=PyYAML-5.4.1-cp311-cp311-linux_aarch64.whl size=45659 sha256=839fc1ab47285af45c199736799509630fa901c2bcd8e1b35dcde867e6860c81
#11 6.241   Stored in directory: /root/.cache/pip/wheels/13/d5/5b/082ef0599cd0dde3d1f273ceebebe6cda67201058a70ade961
#11 6.242 Successfully built PyYAML
#11 6.242 Failed to build lxml
#11 6.276 Installing collected packages: webencodings, soupsieve, six, PyYAML, Markdown, lxml, bracex, backrefs, wcmatch, pymdown-extensions, html5lib, beautifulsoup4, pyspelling
#11 6.352   Running setup.py install for lxml: started
#11 6.499   Running setup.py install for lxml: finished with status 'error'
#11 6.514   error: subprocess-exited-with-error
#11 6.514
#11 6.514   × Running setup.py install for lxml did not run successfully.
#11 6.514   │ exit code: 1
#11 6.514   ╰─> [85 lines of output]
#11 6.514       Building lxml version 4.9.1.
#11 6.514       Building without Cython.
#11 6.514       Building against libxml2 2.9.10 and libxslt 1.1.34
#11 6.514       running install
#11 6.514       /usr/local/lib/python3.11/site-packages/setuptools/command/install.py:34: SetuptoolsDeprecationWarning: setup.py install is deprecated. Use build and pip and other standards-based tools.
#11 6.514         warnings.warn(
#11 6.514       running build
#11 6.514       running build_py
#11 6.514       creating build
#11 6.514       creating build/lib.linux-aarch64-cpython-311
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/_elementpath.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/sax.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/doctestcompare.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/pyclasslookup.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/cssselect.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/usedoctest.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/ElementInclude.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/builder.py -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/defs.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/diff.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/html5parser.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/_html5builder.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/_setmixin.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/soupparser.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/usedoctest.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/_diffcommand.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/clean.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/builder.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/formfill.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       copying src/lxml/html/ElementSoup.py -> build/lib.linux-aarch64-cpython-311/lxml/html
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron
#11 6.514       copying src/lxml/isoschematron/__init__.py -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron
#11 6.514       copying src/lxml/etree.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/etree_api.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/lxml.etree.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/lxml.etree_api.h -> build/lib.linux-aarch64-cpython-311/lxml
#11 6.514       copying src/lxml/includes/c14n.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/relaxng.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/uri.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/xmlparser.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/etreepublic.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/dtdvalid.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/tree.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/xmlerror.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/__init__.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/xinclude.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/config.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/xmlschema.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/htmlparser.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/schematron.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/xpath.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/xslt.pxd -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/lxml-version.h -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       copying src/lxml/includes/etree_defs.h -> build/lib.linux-aarch64-cpython-311/lxml/includes
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/rng
#11 6.514       copying src/lxml/isoschematron/resources/rng/iso-schematron.rng -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/rng
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl
#11 6.514       copying src/lxml/isoschematron/resources/xsl/XSD2Schtrn.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl
#11 6.514       copying src/lxml/isoschematron/resources/xsl/RNG2Schtrn.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl
#11 6.514       creating build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_dsdl_include.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_schematron_message.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_schematron_skeleton_for_xslt1.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_abstract_expand.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/iso_svrl_for_xslt1.xsl -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       copying src/lxml/isoschematron/resources/xsl/iso-schematron-xslt1/readme.txt -> build/lib.linux-aarch64-cpython-311/lxml/isoschematron/resources/xsl/iso-schematron-xslt1
#11 6.514       running build_ext
#11 6.514       building 'lxml.etree' extension
#11 6.514       creating build/temp.linux-aarch64-cpython-311
#11 6.514       creating build/temp.linux-aarch64-cpython-311/src
#11 6.514       creating build/temp.linux-aarch64-cpython-311/src/lxml
#11 6.514       gcc -pthread -Wsign-compare -DNDEBUG -g -fwrapv -O3 -Wall -fPIC -DCYTHON_CLINE_IN_TRACEBACK=0 -I/usr/include/libxml2 -Isrc -Isrc/lxml/includes -I/usr/local/include/python3.11 -c src/lxml/etree.c -o build/temp.linux-aarch64-cpython-311/src/lxml/etree.o -w
#11 6.514       Compile failed: command 'gcc' failed: No such file or directory
#11 6.514       cc -I/usr/include/libxml2 -I/usr/include/libxml2 -c /tmp/xmlXPathInitndtq4698.c -o tmp/xmlXPathInitndtq4698.o
#11 6.514       *********************************************************************************
#11 6.514       Could not find function xmlCheckVersion in library libxml2. Is libxml2 installed?
#11 6.514       *********************************************************************************
#11 6.514       error: command 'gcc' failed: No such file or directory
#11 6.514       [end of output]
#11 6.514
#11 6.514   note: This error originates from a subprocess, and is likely not a problem with pip.
#11 6.516 error: legacy-install-failure
#11 6.516
#11 6.516 × Encountered error while trying to install package.
#11 6.516 ╰─> lxml
#11 6.516
#11 6.516 note: This is an issue with the package mentioned above, not pip.
#11 6.516 hint: See above for output from the failure.
------
executor failed running [/bin/sh -c pip3 install -r /requirements.txt]: exit code: 1
jonasbn@silverrocket:~/develop/github-collabs/spellcheck-github-actions

Possible to ignore words in magic commands?

We use this action to check our markdown prior to publishing to GitBook. In GitBook, we can embed videos with the following magic command:

{% embed url="https://www.youtube.com/watch?v=0Uga3GVXgMw" %}

I see that the action can ignore markdown links as per #24 , bit it seems to miss magic commands such as this. I get the following output:

Using pyspelling on configuration outlined in >.spellcheck.yaml<
Checking files matching specified outlined in >.spellcheck.yaml<
----------------------------------------------------------------
Misspelled words:
<htmlcontent> edge-impulse-python-sdk/overview.md: html>body>p
--------------------------------------------------------------------------------
GVXgMw
Uga
--------------------------------------------------------------------------------

!!!Spelling check failed!!!
Error: Files in repository contain spelling errors

Is there any way to specify ignore strings between characters/strings, for example, between {% and %}?

Version 0.3.0 appears to have an issue when no files matching the source targets exist in the repo the action is being applied too?

See this for full output.

Run rojopolis/[email protected]
/usr/bin/docker run --name e87b52981d34139d40432493cfa05669cb2827_071f17 --label e87b52 --workdir /github/workspace --rm -e HOME -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e GITHUB_ACTIONS=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/p2pmem-pci/p2pmem-pci":"/github/workspace" e87b52:981d34139d40432493cfa05669cb2827
Traceback (most recent call last):
  File "/usr/local/bin/pyspelling", line 8, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__main__.py", line 34, in main
    debug=args.debug
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__main__.py", line 59, in run
    debug=debug
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 662, in spellcheck
    for result in spellchecker.run_task(task, source_patterns=sources):
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 306, in run_task
    for sources in self._walk_src(source_patterns, glob_flags, self.pipeline_steps, expect_match):
  File "/usr/local/lib/python3.7/site-packages/pyspelling/__init__.py", line 207, in _walk_src
    '\n'.join('- {}'.format(target) for target in targets)
RuntimeError: None of the source targets from the configuration match any files:

See this output.

issue running spellcheck action

My spellchecker action is the following:

  
name: Spell Checker

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Spellcheck Action
      uses: rojopolis/[email protected]

I tried to do spellcheck on push and pr and it failed. This build can be found at https://github.com/HPC-buildtest/buildtest-framework/commit/9ae66e412c0545977d08c15d0952f62b91d253ee/checks?check_suite_id=402308725

It is looking for a /wordlist file which is not found

Markdown with html

Markdown

# About
The IBM® RPA Command Line Interface (RPA CLI) is an *unofficial* tool that provides a interface to manage and deploy IBM® RPA projects. RPA CLI commands are covered in the accompanying user guide, including descriptions, syntax, and usage examples.

<div>
  <ol class="card-list">
    <li class="card">
      <div class="inner-card">
        <div class="card-header">
          <div class="inner-card-header">
            <h3>
              <a href="#/guide/readme"><span>User Guide</span></a>
            </h3>
          </div>
        </div>
        <div class="card-section" style="width: 100%;">
          <div class="card-section-content">
            <div>
              <div class="inner-content">
                 Describes all the RPA CLI concepts and provides instructions on using the various features of the latest version of the RPA CLI.
              </div>
            </div>
          </div>
        </div>
      </div>
    </li>
    <li class="card">
      <div class="inner-card">
        <div class="card-header">
          <div class="inner-card-header">
            <h3>
              <a href="#reference"><span>Command Reference</span></a>
            </h3>
          </div>
        </div>
        <div class="card-section" style="width: 100%;">
          <div class="card-section-content">
            <div>
              <div class="inner-content">
                 Describes the latest version of the RPA CLI in detail and provides basic syntax, options, and usage examples for each operation.
              </div>
            </div>
          </div>
        </div>
      </div>
    </li>
  </ol>
</div>

# Author
...

I get these mispells

Misspelled words:
<markdown> docs/README.md
--------------------------------------------------------------------------------
getpino
githubusercontent
href
https
img
ol
readme
src

How can I tell this tool to skip HTML within markdown?

I've tried using pymdownx.striphtml and pymdownx.superfences extensions, but it does not work.

matrix:
- name: Markdown
  aspell:
    lang: en
    ignore-case: true
  dictionary:
    wordlists:
    - spellcheck/wordlist.txt
    encoding: utf-8
  pipeline:
  - pyspelling.filters.markdown:
      markdown_extensions:
      - pymdownx.striphtml
      - pymdownx.superfences
  sources:
  - 'docs/*.md'
  default_encoding: utf-8

Ability to run only on files modified in a PR.

Even though am using:

on:
  pull_request:
    branches: [ master ]

The action still runs on the Whole Codebase.

This makes action really slow for a huge Repository, it would be great if we can only check files modified in a PR.

rojopolis / spellcheck-github-actions Goto Github PK

spellcheck-github-actions's People

Contributors

Stargazers

Watchers

Forkers

spellcheck-github-actions's Issues

Discussed in #99

🔤 User Story

ℹ️ Notes

🆗 Acceptance Criteria

➡️ Resources and References

Recommend Projects

Recommend Topics

Recommend Org

Jobs