Skip to content

ci: add typo check to ci#5491

Merged
dougch merged 11 commits intoaws:mainfrom
brimonk:typos
Dec 8, 2025
Merged

ci: add typo check to ci#5491
dougch merged 11 commits intoaws:mainfrom
brimonk:typos

Conversation

@brimonk
Copy link
Copy Markdown
Contributor

@brimonk brimonk commented Aug 29, 2025

Resolved issues:

resolves #5051

Description of changes:

Added the typos check as per the suggestions in #5051, with a duplication of the typos check in s2n-quic. Also fixed a few typos as I went along.

Testing:

I opened up a PR against my fork of the repo, and can confirm that the typos check will fail if there are files that fail the typos check.

(History is weird because I felt the need to squash the PR before making this PR)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@brimonk
Copy link
Copy Markdown
Contributor Author

brimonk commented Aug 29, 2025

I think the only thing missing from this being perfect is what to do about (p)assing in tests/integrationv2/README.md - typos takes this to mean assing, and I can't seem to figure out the right regex or mapping to ignore this.

@brimonk
Copy link
Copy Markdown
Contributor Author

brimonk commented Aug 29, 2025

I do also see that I missed .github/config/_typos.toml... Not sure how we'd like to merge the two.

@boquan-fang
Copy link
Copy Markdown
Contributor

Hello @brimonk,

Thanks for cutting this PR to us, and thanks for attempting to improve our CI!

I have assigned reviewers for this PR, and we will take a look.

Comment on lines +16 to +18
# While we build up the extend-words list
[type.cpp]
check-file = false
Copy link
Copy Markdown
Contributor

@lrstewart lrstewart Aug 29, 2025

Choose a reason for hiding this comment

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

Maybe I'm misunderstanding the documentation, but doesn't this have the same effect as adding "*.cpp" to extend-exclude below? Mixing the two ignore mechanisms might be confusing. Like, it seems odd that we ignore .c files via type.c but ignore .h files via extend-exclude.

In general I'm having a hard time figuring out what files this check is and isn't currently running on. Comments might help, but maybe we should also be running "typos --files" as part of the action?

@brimonk brimonk requested a review from dougch as a code owner August 29, 2025 23:38
@github-actions
Copy link
Copy Markdown

This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@dougch dougch self-assigned this Nov 12, 2025
@dougch dougch added the type/ci CodeBuild or CI related label Nov 12, 2025
@dougch
Copy link
Copy Markdown
Contributor

dougch commented Nov 12, 2025

Getting back to this... some additional mistakes have crept in, if we can get those last few corrections updated we can get this merged.

brimonk and others added 2 commits December 1, 2025 20:24
Co-authored-by: Doug Chapman <54039637+dougch@users.noreply.github.com>
@dougch
Copy link
Copy Markdown
Contributor

dougch commented Dec 4, 2025

The latest run found a few more typos... can you take a look?

Another request, it looks like I added a config file long ago, in anticipation- could you remove this duplicate ? https://github.com/aws/s2n-tls/blob/main/.github/config/_typos.toml

@boquan-fang boquan-fang changed the title add typo check to ci ci: add typo check to ci Dec 5, 2025
@dougch dougch added this pull request to the merge queue Dec 8, 2025
Merged via the queue into aws:main with commit 8416074 Dec 8, 2025
54 checks passed
kaukabrizvi pushed a commit to kaukabrizvi/s2n-tls that referenced this pull request Dec 8, 2025
Co-authored-by: Boquan Fang <boquanfang3@gmail.com>
Co-authored-by: James Mayclin <maycj@amazon.com>
Co-authored-by: Doug Chapman <54039637+dougch@users.noreply.github.com>
@brimonk brimonk deleted the typos branch December 23, 2025 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/ci CodeBuild or CI related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add spellcheck to CI

5 participants