[skip jenkins] Add spellchecker to pre-commit hooks#706
Merged
Conversation
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Zeitsperre
requested review from
fmigneault,
mishaschwartz and
tlvu
as code owners
github-actions
Bot
added
documentation
tlvu
approved these changes
May 19, 2026
Collaborator
tlvu
left a comment
tlvu
left a comment
There was a problem hiding this comment.
LGTM but I just want to ensure the spell-checker will not touch the code (variable name) but only comments? And what if we have a "look-a-like" product, ex: if ever Ngix actually exists, will it still auto-correct to Nginx?
Collaborator
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/4287/Result 🆘 ABORTEDBIRDHOUSE_DEPLOY_BRANCH : spelling DACCS_IAC_BRANCH : master DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-154.rdext.crim.ca
|
Member
Author
This is solely a spellchecker. It doesn't perform any corrections. All corrections (or exceptions) need to be done manually.
We would then add 'ngix' to the |
Collaborator
OH !!! I thought all the corrections in here are made by the new spell-checker ! I've seen you added other pre-commit hook in other repos that directly clean some metadata in notebooks when they are pushed to a PR so I though this one does the same. |
mishaschwartz
approved these changes
May 20, 2026
fmigneault
approved these changes
May 20, 2026
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Collaborator
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/4290/Result ❌ FAILUREBIRDHOUSE_DEPLOY_BRANCH : spelling DACCS_IAC_BRANCH : master DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-118.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/827/NOTEBOOK TEST RESULTS |
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Collaborator
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/4330/Result ❌ FAILUREBIRDHOUSE_DEPLOY_BRANCH : spelling DACCS_IAC_BRANCH : master DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-118.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/851/NOTEBOOK TEST RESULTS |
Collaborator
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/4331/Result ❌ FAILUREBIRDHOUSE_DEPLOY_BRANCH : spelling DACCS_IAC_BRANCH : master DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-216.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/852/NOTEBOOK TEST RESULTS |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a spellchecking tool to the
pre-commithooks and addresses several typos throughout the code base.The dictionary of ignored words can either be passed via a newline-separated list of words or directly via command-line argument. The ignored-words-list argument can be found in the
pre-commithook.Misspelled words will be caught by the linting tools and will need to be addressed before other checks are performed.
Changes
Non-breaking changes
pre-commitcheck for common spelling mistakes.CHANGES.md.Additional Information
https://github.com/codespell-project/codespell
CI Operations
birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false