Skip to content

Streamline use of pre-commit in GitHub workflows#1186

Merged
jakob-keller merged 2 commits intoaio-libs:masterfrom
jakob-keller:remove-github-workflow-pre-commit
Aug 26, 2024
Merged

Streamline use of pre-commit in GitHub workflows#1186
jakob-keller merged 2 commits intoaio-libs:masterfrom
jakob-keller:remove-github-workflow-pre-commit

Conversation

@jakob-keller
Copy link
Collaborator

@jakob-keller jakob-keller commented Aug 23, 2024 •
edited
Loading

Description of Change

  • pre-commit step as part of CI/CD workflow is run across the matrix of Python versions.
  • Custom pre-commit GitHub Actions workflow is removed.

Assumptions

Checklist for All Submissions

  • I have added change info to CHANGES.rst
  • If this is resolving an issue (needed so future developers can determine if change is still necessary and under what conditions) (can be provided via link to issue with these details):
    • Detailed description of issue
    • Alternative methods considered (if any)
    • How issue is being resolved
    • How issue can be reproduced
  • If this is providing a new feature (can be provided via link to issue with these details):
    • Detailed description of new feature
    • Why needed
    • Alternatives methods considered (if any)

Checklist when updating botocore and/or aiohttp versions

  • I have read and followed CONTRIBUTING.rst
  • I have updated test_patches.py where/if appropriate (also check if no changes necessary)
  • I have ensured that the awscli/boto3 versions match the updated botocore version

@jakob-keller jakob-keller added the github_actions Pull requests that update GitHub Actions code label Aug 23, 2024
@jakob-keller jakob-keller self-assigned this Aug 23, 2024
@codecov
Copy link

codecov bot commented Aug 23, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.94%. Comparing base (69ceb7a) to head (c4b6995).
Report is 40 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1186   +/-   ##
=======================================
  Coverage   86.94%   86.94%           
=======================================
  Files          64       64           
  Lines        5983     5983           
=======================================
  Hits         5202     5202           
  Misses        781      781
Flag Coverage Δ
unittests 86.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

@jakob-keller jakob-keller force-pushed the remove-github-workflow-pre-commit branch from e646c69 to d820298 Compare August 23, 2024 22:01
@webknjaz
Copy link
Member

webknjaz commented Aug 23, 2024

It's usually good to move it into the regular CI/CD workflow. pre-commit.ci has some limitations when it comes to linters needing network access or external environments (which can be the case for pylint).
Though, it's better to exercise the same invocation method as the contributors would (tox/nox/make), to make sure this contributing workflow bit is healthy.

@jakob-keller jakob-keller force-pushed the remove-github-workflow-pre-commit branch from d820298 to 1856ef6 Compare August 24, 2024 09:46
@jakob-keller
Copy link
Collaborator Author

jakob-keller commented Aug 24, 2024

Pre PR we were running pre-commit hooks up to three times on GitHub:

  1. as part of the CI/CD workflow, but only for Python 3.11
  2. as a dedicated workflow with Python 3.x, currently 3.12
  3. through pre-commit.ci (since this week)

This PR would run 1. across the entire matrix (currently Python 3.8 - 3.13) and remove 2.

Further improvements, such as introducing tox, are out of scope of this PR.

@jakob-keller jakob-keller changed the title Remove GitHub Actions workflow pre-commit Streamline use of pre-commit in GitHub workflows Aug 24, 2024
@jakob-keller jakob-keller force-pushed the remove-github-workflow-pre-commit branch from 1856ef6 to c4b6995 Compare August 25, 2024 19:06
@jakob-keller jakob-keller merged commit 1aa309d into aio-libs:master Aug 26, 2024
@jakob-keller jakob-keller deleted the remove-github-workflow-pre-commit branch August 26, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@webknjaz webknjaz webknjaz approved these changes

@thehesiod thehesiod Awaiting requested review from thehesiod

Assignees

@jakob-keller jakob-keller

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jakob-keller @webknjaz