Skip to content

chore: enhance typo check workflow#667

Merged
RomainMuller merged 2 commits into
DataDog:mainfrom
atilsensalduz:ci/add-typo-check
Aug 12, 2025
Merged

chore: enhance typo check workflow#667
RomainMuller merged 2 commits into
DataDog:mainfrom
atilsensalduz:ci/add-typo-check

Conversation

@atilsensalduz

@atilsensalduz atilsensalduz commented Jul 18, 2025

Copy link
Copy Markdown
Contributor

This PR adds a typo check to CI using the typos GitHub Action. I also created a .typos.toml config file so we can ignore certain words that are either project specific, technical terms, or intentionally spelled that way. Without this config, the action would flag a lot of false positives, so this should make the checks more useful and less noisy.

If you notice any words in the whitelist that actually are typos and should be fixed, feel free to update the config or let me know. For example, I wasn’t sure whether to change “qualifed” to “qualified”, since it appears in a lot of places and might be intentional.

https://github.com/crate-ci/typos

@atilsensalduz
atilsensalduz requested a review from a team as a code owner July 18, 2025 09:17

@kakkoyun kakkoyun left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looking good.

Thanks for the contribution.

Comment thread typos.yaml Outdated
@atilsensalduz

Copy link
Copy Markdown
Contributor Author

I just noticed that the repository is already using the typos tool, but only for checking documentation. Should I leave spelling workflow as is, or would it be better to add the config file to the existing validate workflow and run it on all files? Alternatively, I can remove the new separate workflow for spelling and stick with checking only the docs as before?
Sorry for the inconvenience. I didn’t notice this before opening the PR. 🤦

@kakkoyun

Copy link
Copy Markdown
Member

I just noticed that the repository is already using the typos tool, but only for checking documentation. Should I leave spelling workflow as is, or would it be better to add the config file to the existing validate workflow and run it on all files? Alternatively, I can remove the new separate workflow for spelling and stick with checking only the docs as before? Sorry for the inconvenience. I didn’t notice this before opening the PR. 🤦

Nothing to worry about. As a reviewer, I have forgotten we have added it.
Feel free to improve the existing setup.

@kakkoyun kakkoyun left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@RomainMuller

RomainMuller commented Aug 12, 2025

Copy link
Copy Markdown
Contributor

@atilsensalduz - this repository can (currently) only accept commits with valid signatures... Would you be able to set up git commit signing (see GitHub's guide @ https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) and then update this PR to contain only signed commits?

Otherwise, we'll need to update this repository settings to accept un-signed commits from third-party contributors (it's fine for us to do this but will take a short while).

Never mind, I've just re-committed these leaving you as the author on record.

@RomainMuller RomainMuller changed the title CI: Add typo check workflow chore: enhance typo check workflow Aug 12, 2025
@RomainMuller
RomainMuller enabled auto-merge August 12, 2025 14:10
@RomainMuller RomainMuller added the conventional-commit/chore Maintenance work that does not show up in the release notes label Aug 12, 2025
@RomainMuller
RomainMuller added this pull request to the merge queue Aug 12, 2025
Merged via the queue into DataDog:main with commit 812e2ce Aug 12, 2025
44 checks passed
@atilsensalduz

Copy link
Copy Markdown
Contributor Author

Really appreciate the merge, @RomainMuller and @kakkoyun I'll set up GPG signing for my future commits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conventional-commit/chore Maintenance work that does not show up in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants