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: link lint + spell check #179

Merged
merged 7 commits into from
Mar 27, 2024
Merged

CI: link lint + spell check #179

merged 7 commits into from
Mar 27, 2024

Conversation

Reecepbcups
Copy link
Member

@Reecepbcups Reecepbcups commented Mar 21, 2024

closes #178

Fixes all broken links and common spelling issues

@github-actions github-actions bot added packet-forward-middleware Label for items related to the packet forward middleware ibc-hooks Label for items related to Osmosis' ibc-hooks implementation async-icq Label for items related to the async-icq module labels Mar 21, 2024
README.md Show resolved Hide resolved
@Reecepbcups Reecepbcups changed the title mark down lint & incorrect spelling CI: link lint + spell check Mar 21, 2024
@Reecepbcups Reecepbcups marked this pull request as ready for review March 21, 2024 04:23
@Reecepbcups Reecepbcups enabled auto-merge (squash) March 21, 2024 05:23
Copy link
Member

@jtieri jtieri left a comment

Choose a reason for hiding this comment

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

had a couple questions but otherwise this lgtm

@@ -0,0 +1,5 @@
[codespell]
skip = *.pulsar.go,*.pb.go,*.pb.gw.go,*.cosmos_orm.go,*.json,*.git,*.js,crypto/keys,fuzz,*.h,proto/tendermint,*.bin,*.sum,*.mod,*_test.go
Copy link
Member

Choose a reason for hiding this comment

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

i notice that here we skip Go test files but your PR in the relayer didn't, is this on purpose?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, many test files use things like userA, step, and other words which are commonly flagged as incorrectly spelled. With the different cases it messes with codespell and is kind of a pain. so just ignoring for now

200,
206
]
}
Copy link
Member

Choose a reason for hiding this comment

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

why the need for this config file in this repo but not in the relayer repo?

Copy link
Member Author

Choose a reason for hiding this comment

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

There are more links in this repo and some edge case URLs being used. Given the higher failure rate the config helps with some flakey URLs (cough cough twittter)

@Reecepbcups Reecepbcups merged commit 26f3ad8 into main Mar 27, 2024
18 checks passed
@Reecepbcups Reecepbcups deleted the reece/more-ci branch March 27, 2024 22:05
@jtieri
Copy link
Member

jtieri commented Mar 27, 2024

If it's not any trouble could we backport this to the other maintained branches? If you don't have any extra bandwidth we could just open an issue as a reminder and get someone else assigned to it at some point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
async-icq Label for items related to the async-icq module ibc-hooks Label for items related to Osmosis' ibc-hooks implementation packet-forward-middleware Label for items related to the packet forward middleware
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add broken link check CI
2 participants