8000 [ci] Add spelling checks by vgvassilev · Pull Request #293 · compiler-research/compiler-research.github.io · GitHub
[go: up one dir, main page]

Skip to content

[ci] Add spelling checks #293

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

Merged
merged 1 commit into from
May 19, 2025
Merged

[ci] Add spelling checks #293

merged 1 commit into from
May 19, 2025

Conversation

vgvassilev
Copy link
Contributor

No description provided.

@vgvassilev vgvassilev force-pushed the vgvassilev-patch-1 branch from b2e1130 to 0c1312e Compare May 13, 2025 14:19
@vgvassilev
Copy link
Contributor Author

@mcbarton I think I am now stuck. I am trying to implement some check based on rojopolis/spellcheck-github-actions and its documentation to spell check the PR diff only for the markdown changes. Do you think you can have a look?

@mcbarton
Copy link
Contributor

@mcbarton I think I am now stuck. I am trying to implement some check based on rojopolis/spellcheck-github-actions and its documentation to spell check the PR diff only for the markdown changes. Do you think you can have a look?

@vgvassilev You have no checkout action in the repo, so it never checks out this repo, and therefore can never find .github/workflows/spellcheck.yaml

sources:
- "**/*.md"
- "**/*.tex"
- "**/*.txt"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think source_files in the workflow overrides this, so can probably remove sources: here

@vgvassilev
Copy link
Contributor Author

@mcbarton I think I am now stuck. I am trying to implement some check based on rojopolis/spellcheck-github-actions and its documentation to spell check the PR diff only for the markdown changes. Do you think you can have a look?

@vgvassilev You have no checkout action in the repo, so it never checks out this repo, and therefore can never find .github/workflows/spellcheck.yaml

Fixed but there is still something up.

@mcbarton
Copy link
Contributor

@mcbarton I think I am now stuck. I am trying to implement some check based on rojopolis/spellcheck-github-actions and its documentation to spell check the PR diff only for the markdown changes. Do you think you can have a look?

@vgvassilev You have no checkout action in the repo, so it never checks out this repo, and therefore can never find .github/workflows/spellcheck.yaml

Fixed but there is still something up.

I think its saying that there are no markdown files that have been changed. Try changing one to see if that is the case

If it passes with a changed markdown file, then add

paths:
  - '**.md'

to when the workflow will activate, like https://github.com/compiler-research/CppInterOp/blob/28ba16e97f58d0364b610bad9371bc4ea8e8b304/.github/workflows/markdown-linter.yml#L7 in CppInterOp

@vgvassilev
Copy link
Contributor Author

Yes, but there will be PRs that don’t involve markdown changes. The check should not fail under such circumstances.

@mcbarton
Copy link
Contributor
mcbarton commented May 13, 2025

If you don't want to only activate the workflow if a .md file is modified, then you probably need something like what I did here for the ids workflow in llvm https://github.com/llvm/llvm-project/blob/0e30999cc1bfe23678591fdb9a0052c9ce7d0099/.github/workflows/ids-check.yml#L72 . e.g. create an environment variable that is blank if no .md files is changed (or whatever file extensions your interested in), and only do the 'Run Spellcheck' section if its not blank

@vgvassilev vgvassilev force-pushed the vgvassilev-patch-1 branch from 4526149 to 1fde5b4 Compare May 19, 2025 13:43
@vgvassilev vgvassilev force-pushed the vgvassilev-patch-1 branch from 1fde5b4 to 66e3896 Compare May 19, 2025 13:45
@vgvassilev vgvassilev merged commit 7156006 into master May 19, 2025
2 checks passed
@vgvassilev vgvassilev deleted the vgvassilev-patch-1 branch May 19, 2025 13:46
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.

2 participants
0