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

ci: support spellcheck of markdown and rst files #359

Merged
merged 2 commits into from
Oct 25, 2023

Conversation

baprusty
Copy link
Contributor

@baprusty baprusty commented Oct 23, 2023

  • This action will auto check spellings in .md and .rst files in the repo
  • wordlist.txt consists of all the words that are added to dictionary and
    should be ignored while spell checking

Closes: #286
Signed-off-by: Badrikesh Prusty badrikesh.prusty@siemens.com

@baprusty
Copy link
Contributor Author

Hi @chombourger, For the task: #286 (ci: spell check markdown documents)
I tried the following ci job: rojopolis/spellcheck-github-actions (https://github.com/rojopolis/spellcheck-github-actions)
Currently I just added spellchecks for some .md files, will check with rst files in docs if required.

Kindly check if the following approach okay for this task, or some other methods we should check for this ?

@github-actions github-actions bot requested a review from chombourger October 23, 2023 19:27
@chombourger
Copy link
Collaborator

yes this does look fine, thanks!

@baprusty
Copy link
Contributor Author

baprusty commented Oct 24, 2023

Spell check logs:

 Using pyspelling on configuration outlined in >.github/spellcheck_config.yml<
Checking files matching specified outlined in >.github/spellcheck_config.yml<
----------------------------------------------------------------
Using aspell to spellcheck Markdown
Running Task: Markdown...
Compiling Dictionary...
> Processing: README.md
> Processing: CONTRIBUTING.md
> Processing: MAINTAINERS.md
> Processing: docs/install.rst
> Processing: docs/FAQ.rst
> Processing: docs/usage.rst
> Processing: docs/build.rst
> Processing: docs/config.rst
> Processing: docs/intro.rst
> Processing: docs/dev.rst
> Processing: docs/index.rst
> Processing: docs/fixtures.rst
> Processing: docs/integration.rst

Spelling check passed :)

Spellcheck actions log: https://github.com/siemens/mtda/actions/runs/6632646598/job/18018773459

@baprusty baprusty changed the title ci: support spellcheck of markdown and rst files [HOLD] ci: support spellcheck of markdown and rst files Oct 24, 2023
@baprusty
Copy link
Contributor Author

@chombourger Please review
Updated the PR, this will perform spellcheck action for all .md files and docs/*.rst files

.github/wordlist.txt Outdated Show resolved Hide resolved
docs/build.rst Outdated Show resolved Hide resolved
docs/build.rst Outdated Show resolved Hide resolved
@chombourger
Copy link
Collaborator

The following files have no copyright and licensing information:
* .github/spellcheck_config.yml
* .github/wordlist.txt

we will need to add copyright/license info to the above files

@baprusty
Copy link
Contributor Author

The following files have no copyright and licensing information:
* .github/spellcheck_config.yml
* .github/wordlist.txt

we will need to add copyright/license info to the above files

Added license info for these files

- This action will auto check spellings in .md and .rst files in the repo
- wordlist.txt consists of all the words that are added to dictionary and
  should be ignored while spell checking

Closes: siemens#286
Signed-off-by: Badrikesh Prusty <badrikesh.prusty@siemens.com>
Signed-off-by: Badrikesh Prusty <badrikesh.prusty@siemens.com>
@chombourger chombourger merged commit c58faa8 into siemens:master Oct 25, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ci: spell check markdown documents
2 participants