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-16865 cq: update flake8 to 7.1.1 #15575

Merged
merged 1 commit into from
Dec 9, 2024
Merged

DAOS-16865 cq: update flake8 to 7.1.1 #15575

merged 1 commit into from
Dec 9, 2024

Conversation

daltonbohning
Copy link
Contributor

Update flake8 to 7.1.1.
Adjust githook to work with newer flake8.
Also tested to be backwards compatible with flake8<6

Skip-build: true

Required-githooks: 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.

@daltonbohning
DAOS-16865 cq: update flake8 to 7.1.1
6a16cd2 
Update flake8 to 7.1.1.
Adjust githook to work with newer flake8.
Also tested to be backwards compatible with flake8<6

Skip-build: true

Required-githooks: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning daltonbohning self-assigned this Dec 9, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 9, 2024

Ticket title is 'githooks: support flake8>6'
Status is 'In Progress'
https://daosio.atlassian.net/browse/DAOS-16865

@daltonbohning daltonbohning marked this pull request as ready for review December 9, 2024 19:38
brianjmurrell
brianjmurrell suggested changes Dec 9, 2024
View reviewed changes
utils/githooks/pre-commit.d/71-flake.sh
Comment on lines -29 to -30
if flake8 --version | grep ^6\\.; then
echo "flake8 >= 6.x does not have the --diff option. Skipping."
Copy link
Contributor

Choose a reason for hiding this comment

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

This check is needed for platforms not managing the CQ dependencies with pip, that might be stuck at 6.0.0.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It isn't needed anymore because I made the githook work with newer and older versions

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 specifically did not want to break backwards compat so I verified the hook still works with python 3.6 + flake<6 (what we use today) and python3.9 + flake 7.1.1 (what this PR updates to)

daltonbohning
daltonbohning commented Dec 9, 2024
View reviewed changes
utils/githooks/pre-commit.d/71-flake.sh

# non-scons
git diff "$TARGET" -U10 | flake8 --config .flake8 --diff
if ! echo "$py_files" | grep -vi scons | xargs flake8 --config .flake8; then
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@brianjmurrell The idea is instead of using the --diff option, we pipe the files to flake agnostically

Copy link
Contributor

Choose a reason for hiding this comment

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

Ahhh. I see.

brianjmurrell
brianjmurrell approved these changes Dec 9, 2024
View reviewed changes
utils/githooks/pre-commit.d/71-flake.sh

# non-scons
git diff "$TARGET" -U10 | flake8 --config .flake8 --diff
if ! echo "$py_files" | grep -vi scons | xargs flake8 --config .flake8; then
Copy link
Contributor

Choose a reason for hiding this comment

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

Ahhh. I see.

@daltonbohning daltonbohning requested a review from a team December 9, 2024 22:12
@daltonbohning daltonbohning added the forced-landing The PR has known failures or has intentionally reduced testing, but should still be landed. label Dec 9, 2024
@daltonbohning daltonbohning merged commit 4f472cf into master Dec 9, 2024
53 checks passed
@daltonbohning daltonbohning deleted the dbohning/daos-16865 branch December 9, 2024 22:13
daltonbohning added a commit that referenced this pull request Dec 11, 2024
@daltonbohning
DAOS-16865 cq: update flake8 to 7.1.1 (#15575)
7bf0a3c 
Update flake8 to 7.1.1.
Adjust githook to work with newer flake8.
Also tested to be backwards compatible with flake8<6

Skip-build: true

Required-githooks: true

Signed-off-by: Dalton Bohning <[email protected]>
daltonbohning added a commit that referenced this pull request Dec 12, 2024
@daltonbohning
DAOS-16865 cq: update flake8 to 7.1.1 (#15575) (#15597)
68b3a03 
Update flake8 to 7.1.1.
Adjust githook to work with newer flake8.
Also tested to be backwards compatible with flake8<6

Signed-off-by: Dalton Bohning <[email protected]>
@juszhan1 juszhan1 mentioned this pull request Dec 23, 2024
Closed
@mjmac mjmac mentioned this pull request Jan 13, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianjmurrell brianjmurrell brianjmurrell approved these changes

@phender phender phender approved these changes

@YinglinSun YinglinSun Awaiting requested review from YinglinSun

Assignees

@daltonbohning daltonbohning

Labels
forced-landing The PR has known failures or has intentionally reduced testing, but should still be landed.
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@daltonbohning @brianjmurrell @phender