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.

Sign up for GitHub

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

Jump to bottom

DAOS-17133 ci: Add to codespell skip list #15932

Merged
merged 2 commits into from
Feb 18, 2025
Merged

DAOS-17133 ci: Add to codespell skip list #15932

merged 2 commits into from
Feb 18, 2025

Conversation

jolivier23
Copy link
Contributor

@jolivier23 jolivier23 commented Feb 18, 2025 •
edited
Loading

Skip *.patch files (we have none in master branch).
Skip same files in githook we do in CI

Skip-build: true
Skip-test: true

Before requesting gatekeeper:

  • Two review approvals and any prior change requests have been resolved.
  • Testing is complete and all tests passed or there is a reason documented in the PR why it should be force landed and forced-landing tag is set.
  • Features: (or Test-tag*) commit pragma was used or there is a reason documented that there are no appropriate tags for this PR.
  • Commit messages follows the guidelines outlined here.
  • Any tests skipped by the ticket being addressed have been run and passed in the PR.

Gatekeeper:

  • You are the appropriate gatekeeper to be landing the patch.
  • The PR has 2 reviews by people familiar with the code, including appropriate owners.
  • Githooks were used. If not, request that user install them and check copyright dates.
  • Checkpatch issues are resolved. Pay particular attention to ones that will show up on future PRs.
  • All builds have passed. Check non-required builds for any new compiler warnings.
  • Sufficient testing is done. Check feature pragmas and test tags and that tests skipped for the ticket are run and now pass with the changes.
  • If applicable, the PR has addressed any potential version compatibility issues.
  • Check the target branch. If it is master branch, should the PR go to a feature branch? If it is a release branch, does it have merge approval in the JIRA ticket.
  • Extra checks if forced landing is requested
    • Review comments are sufficiently resolved, particularly by prior reviewers that requested changes.
    • No new NLT or valgrind warnings. Check the classic view.
    • Quick-build or Quick-functional is not used.
  • Fix the commit message upon landing. Check the standard here. Edit it to create a single commit. If necessary, ask submitter for a new summary.

@jolivier23
DAOS-17133 ci: Add to codespell skip list
f68036f 
Skip *.patch files (we have none in master branch)
Skip same files in githook we do in CI

Skip-build: true
Skip-test: true

Signed-off-by: Jeff Olivier <[email protected]>
@jolivier23 jolivier23 requested a review from a team as a code owner February 18, 2025 19:53
jolivier23
jolivier23 commented Feb 18, 2025
View reviewed changes
.github/workflows/linting.yml
@@ -162,7 +162,7 @@ jobs:
- name: Run check
uses: codespell-project/actions-codespell@406322ec52dd7b488e48c1c4b82e2a8b3a1bf630 # master
with:
skip: ./src/control/vendor,./src/control/go.sum,./.git
skip: ./src/control/vendor,./src/control/go.sum,./.git,./utils/*.patch
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I add these here to reduce potential conflicts between google/2.6 and master branch

daltonbohning
daltonbohning requested changes Feb 18, 2025
View reviewed changes
utils/githooks/pre-commit.d/20-codespell.sh Outdated
@@ -22,4 +23,4 @@ fi

echo "Checking for spelling mistakes"
# Convert file names to relative path format that codespell expects. I.e. "./path"
_git_diff_cached_files | xargs -r -n 1 -I% echo "./%" | xargs -r codespell
_git_diff_cached_files | xargs -r -n 1 -I% echo "./%" | xargs -r codespell --skip ./src/control/vendor,./src/control/go.sum,./utils/*.patch
Copy link
Contributor

Choose a reason for hiding this comment

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

These are actually specified here:

daos/pyproject.toml

Lines 7 to 11 in ae9f129

[tool.codespell]
skip = './src/control/vendor/*,./src/control/go.sum,./.git/*,./src/rdb/raft/*,./build/*,./install/*,./venv/*,./src/control/security/testdata/certs/source.txt'
quiet-level = 3
ignore-words = 'ci/codespell.ignores'
builtin = 'clear,rare,informal,names,en-GB_to_en-US'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I will change it

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 18, 2025 •
edited
Loading

Ticket title is 'codespell needs to skip 3rd party files'
Status is 'In Review'
https://daosio.atlassian.net/browse/DAOS-17133

@jolivier23
Address review comment
1f5b0b2 
Skip-build: true
Skip-test: true

Signed-off-by: Jeff Olivier <[email protected]>
@jolivier23 jolivier23 merged commit b8e2e36 into master Feb 18, 2025
40 checks passed
@jolivier23 jolivier23 deleted the jvolivie/codespell branch February 18, 2025 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daltonbohning daltonbohning daltonbohning approved these changes

@kjacque kjacque kjacque approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jolivier23 @daltonbohning @kjacque