-
Notifications
You must be signed in to change notification settings - Fork 35
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
Use check-spelling/check-spelling@v0.0.20 #97
Conversation
runs-on: ubuntu-latest | ||
needs: spelling | ||
permissions: | ||
contents: write |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why does the spelling action need contents
write permissions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub treats comment
ing on a commit as a write
operation (on the repository contents). And comment
ing on a pul request as a write operation (on pull requests).
It's an unfortunate detail.
But note that the default permissions on most organizations is roughly *: write
, so this is actually a reduction in the scope permissions of the workflow.
Thanks so much @jsoref. I was looking at the documentation and trying to understand the nuance about the differences between the allowlist and the expectlist, but it didn't seem to be covered. What is the difference between the two lists? |
(Ouch, I just lost my comment.) So, I can add this file to the PR (I sometimes do when refreshing, but apparently didn't here): My current thoughts on improving this in general are here: https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Easier-to-understand-filenames But in short, As check-spelling runs, it compares tokens it finds against its dictionary. Any items not found are then compared against Imagine you had a misspelled item in the repository, it'd be in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again @jsoref for helping us with the upgrade. I'll take a stab at updating the other F' repositories using check-spelling later today.
Note that because of the way github workflows work, you should upgrade all branches. |
Change Description
Refreshes the workflow based on
https://github.com/check-spelling/spell-check-this/blob/744c66e2140fd8acaf5388efd0db3727d010d6e9/.github/workflows/spelling.yml
Rationale
-D
patternTesting/Review Recommendations
Fill in testing procedures, specific items to focus on for review, or other info to help the team verify these changes are flight-quality.
You can create PRs into https://github.com/check-spelling/fprime-tools if you'd like, it's running this version.
Runs were here: https://github.com/check-spelling/fprime-tools/actions/workflows/spelling.yml
I've moved a bunch of items from
expect.txt
toallow.txt
which makes it easier to transition from v0.0.19 to v0.0.20, note that this update changes the minimum word length from2
to3
. Once this is merged, a future PR by someone will remove the 2 letter words fromexpect.txt
.Future Work
There will be future updates to check-spelling. I'm starting to look into SARIF reporting, however I don't have an ETA for it.