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

Move cspell to Actions #35593

Merged
merged 3 commits into from
Jan 30, 2022
Merged

Move cspell to Actions #35593

merged 3 commits into from
Jan 30, 2022

Conversation

XhmikosR
Copy link
Member

@XhmikosR XhmikosR commented Dec 23, 2021

Requires #35573 and #35680

- name: Run cspell
uses: streetsidesoftware/cspell-action@v1.3.5
with:
files: "site/**/*.md"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if we can move this in .cspell.json too? That way everything should work without any arguments.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know if it can help but instead of cspell \"site/**/*.md\" --no-progress, it it possible to manually launch cspell --no-progress and to define the path to analyze in your .cspell.json by adding:

"files": [
  "site/**/*.md"
]

It will maybe work as well with streetsidesoftware/cspell-action@v1.3.5.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, I'll try that, thanks!

@coliff can you confirm if the above works for your use case through an editor?

BTW there's a gitignore option we could add in the config. I'm trying to figure out if it's enabled by default or not.

@coliff
Copy link
Contributor

coliff commented Dec 23, 2021

good idea to move cspell to a GitHub Action - I recently started doing this myself. Perhaps consider adding the following options to cspell.yml:

strict: false
incremental_files_only: true

So that typos are reported but it won't fail (to make it less annoying for any false-positives).

REF: https://github.com/streetsidesoftware/cspell-action#usage

@XhmikosR XhmikosR force-pushed the main-xmr-cspell-action branch from ca7b29c to 7fc3731 Compare December 28, 2021 06:45
@XhmikosR
Copy link
Member Author

good idea to move cspell to a GitHub Action - I recently started doing this myself. Perhaps consider adding the following options to cspell.yml:

strict: false
incremental_files_only: true

So that typos are reported but it won't fail (to make it less annoying for any false-positives).

REF: https://github.com/streetsidesoftware/cspell-action#usage

incremental_files_only is true by default. And since we have already used cspell without an action, it's safe to use it from now on, otherwise it would have missed existent issues. As for strict, we do want the Action to fail if there's a failure.

@XhmikosR XhmikosR force-pushed the main-xmr-cspell-action branch 2 times, most recently from b93cc27 to 01dc15d Compare January 4, 2022 07:37
Copy link

@kabat87 kabat87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

``

@XhmikosR XhmikosR force-pushed the main-xmr-cspell-action branch 7 times, most recently from 35288db to 20bd677 Compare January 11, 2022 09:46
@XhmikosR XhmikosR force-pushed the main-xmr-cspell-action branch from 015036b to ba051fe Compare January 29, 2022 12:44
@XhmikosR XhmikosR marked this pull request as ready for review January 29, 2022 12:48
@XhmikosR XhmikosR merged commit e1020a4 into main Jan 30, 2022
@XhmikosR XhmikosR deleted the main-xmr-cspell-action branch January 30, 2022 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants