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

Improve spellcheck script to allow for projects to specify additional sources #1100

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

adeljo-amd
Copy link
Contributor

This PR contains the following update:

  • Added config to spell-check C++ files in .spellcheck.yaml
  • Added a file .spellcheck.local.yaml that can be used as a reference for other projects when they want to specify additional sources
  • Added a python script docs/yaml_merger.py to merge any project's .spellcheck.local.yaml with the main .spellcheck.yaml in this repository. The script simply checks the nodes name and source and ensures they match before merging the additional sources (node depth must match too). Anything else is ignored.

@adeljo-amd adeljo-amd requested a review from neon60 January 20, 2025 11:15
@adeljo-amd adeljo-amd self-assigned this Jan 20, 2025
@adeljo-amd adeljo-amd requested a review from a team as a code owner January 20, 2025 11:15
@adeljo-amd adeljo-amd force-pushed the local_spellcheck branch 4 times, most recently from 4a04c4b to 8a5852a Compare January 20, 2025 11:42
@adeljo-amd adeljo-amd changed the title Improve spellcheck script to allow for projects to specify additional sources Draft: Improve spellcheck script to allow for projects to specify additional sources Jan 20, 2025
@adeljo-amd adeljo-amd changed the title Draft: Improve spellcheck script to allow for projects to specify additional sources Improve spellcheck script to allow for projects to specify additional sources Jan 20, 2025
docs/yaml_merger.py Outdated Show resolved Hide resolved
.spellcheck.yaml Outdated Show resolved Hide resolved
@adeljo-amd adeljo-amd force-pushed the local_spellcheck branch 2 times, most recently from 4ab21b9 to 65b043c Compare January 21, 2025 08:27
@adeljo-amd adeljo-amd force-pushed the local_spellcheck branch 6 times, most recently from 69d5c3a to d9b629d Compare January 22, 2025 11:27
@adeljo-amd
Copy link
Contributor Author

adeljo-amd commented Jan 22, 2025

Here is a test action in the HIP repository that shows the spellcheck run https://github.com/ROCm/HIP/actions/runs/12868847369/job/35990222242

And in the ROCm repository
https://github.com/ROCm/ROCm/actions/runs/12868894294/job/35992068272

Copy link
Member

@samjwu samjwu left a comment

Choose a reason for hiding this comment

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

I think this may belong to ci: instead of feat: since it's affecting workflow files (for the commitizen commit message)

is there a need to release a new version for this?

@adeljo-amd
Copy link
Contributor Author

I think this may belong to ci: instead of feat: since it's affecting workflow files (for the commitizen commit message)

is there a need to release a new version for this?

Thanks for pointing that out, squashed and adjusted the commit message.

Spoke to @neon60 about the need to release and he says no.

@samjwu samjwu merged commit 5a48fd1 into develop Jan 22, 2025
7 checks passed
@samjwu samjwu deleted the local_spellcheck branch January 22, 2025 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants