feat: Add CI for Spell Checking #10637
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lidel
requested changes
Jan 15, 2025
There was a problem hiding this comment.
Thank you @youyyytrok!
Before merging this we need to fix sharness tests (details inline)
| @@ -882,7 +882,7 @@ test_expect_success "'ipfs add -rn' succeeds" ' | |||
| mkdir -p mountdir/moons/saturn && | |||
| echo "Hello Europa!" >mountdir/moons/jupiter/europa.txt && | |||
| echo "Hello Titan!" >mountdir/moons/saturn/titan.txt && | |||
| echo "hey youre no moon!" >mountdir/moons/mercury.txt && | |||
| echo "hey you are no moon!" >mountdir/moons/mercury.txt && | |||
There was a problem hiding this comment.
@youyyytrok this broke sharness test, do you have bandwidth to update related CIDs in this test file?
- Details https://custom-github-runners-v0-interplanetary-shipyard.s3.amazonaws.com/multi-linux-x64-4xlarge-action-runner/ipfs/kubo/12437951987/3/sharness.html#t0040-add-and-cat →
187 - 'ipfs add -rn'(Failure)
expecting success:
MOONS="QmVKvomp91nMih5j6hYBA8KjbiaYvEetU2Q7KvtZkLe9nQ" &&
EUROPA="Qmbjg7zWdqdMaK2BucPncJQDxiALExph5k3NkQv5RHpccu" &&
JUPITER="QmS5mZddhFPLWFX3w6FzAy9QxyYkaxvUpsWCtZ3r7jub9J" &&
SATURN="QmaMagZT4rTE7Nonw8KGSK4oe1bh533yhZrCo1HihSG8FK" &&
TITAN="QmZzppb9WHn552rmRqpPfgU5FEiHH6gDwi3MrB9cTdPwdb" &&
MERCURY="QmUJjVtnN8YEeYcS8VmUeWffTWhnMQAkk5DzZdKnPhqUdK" &&
echo "added $EUROPA moons/jupiter/europa.txt" >expected &&
echo "added $MERCURY moons/mercury.txt" >>expected &&
echo "added $TITAN moons/saturn/titan.txt" >>expected &&
echo "added $JUPITER moons/jupiter" >>expected &&
echo "added $SATURN moons/saturn" >>expected &&
echo "added $MOONS moons" >>expected &&
test_cmp expected actual
> diff -u expected actual
--- expected 2025-01-15 01:18:02.736999971 +0000
+++ actual 2025-01-15 01:18:02.664999611 +0000
@@ -1,6 +1,6 @@
added Qmbjg7zWdqdMaK2BucPncJQDxiALExph5k3NkQv5RHpccu moons/jupiter/europa.txt
-added QmUJjVtnN8YEeYcS8VmUeWffTWhnMQAkk5DzZdKnPhqUdK moons/mercury.txt
+added QmRsTB5CpEUvDUpDgHCzb3VftZ139zrk9zs5ZcgYh9TMPJ moons/mercury.txt
added QmZzppb9WHn552rmRqpPfgU5FEiHH6gDwi3MrB9cTdPwdb moons/saturn/titan.txt
added QmS5mZddhFPLWFX3w6FzAy9QxyYkaxvUpsWCtZ3r7jub9J moons/jupiter
added QmaMagZT4rTE7Nonw8KGSK4oe1bh533yhZrCo1HihSG8FK moons/saturn
-added QmVKvomp91nMih5j6hYBA8KjbiaYvEetU2Q7KvtZkLe9nQ moons
+added QmbGoaQZm8kjYfCiN1aBsgwhqfUBGDYTrDb91Mz7Dvq81B moons
If not, let us know, we can get to it next week.
|
Hi @lidel ! Done! |
lidel
approved these changes
Jan 22, 2025
lidel
requested changes
Jan 22, 2025
.github/workflows/spellcheck.yml
Outdated
Comment on lines
13
to
14
| - name: Install Codespell | ||
| run: pip install codespell |
There was a problem hiding this comment.
@youyyytrok re-running the same CI job started failing:
– https://github.com/ipfs/kubo/actions/runs/12788199550/job/36008198868#step:4:10
I think this is due to codespell version not being pinned – any way we can control this so it does not break CI every time codespell updates rules?
|
@lidel Hi! Check it🐳 |
|
Triage notes:
|
|
Hi @guillaumemichel ! Done |
|
It seems that ignoring |
|
@guillaumemichel check it👀 |
guillaumemichel
approved these changes
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a Continuous Integration (CI) workflow for detecting spelling mistakes using
codespell. The following changes have been implemented:issue #10633
codespellthroughout the repository.These improvements enhance documentation and code readability while ensuring consistency across the codebase.