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.

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

Add Nox sessions for running pre-commit and checking MANIFEST.in #2695

Merged
merged 13 commits into from
May 18, 2024

Conversation

namurphy
Copy link
Member

@namurphy namurphy commented May 17, 2024

  • I added a lint session for Nox as a shortcut to run pre-commit run --all-files. This is mostly syntactic sugar, but does remove the need to install pre-commit manually.
  • I added the manifest session for Nox to run check-manifest, which checks that all appropriate files are included in MANIFEST.in.
  • I added a configuration for check-manifest in pyproject.toml
  • I updated MANIFEST.in accordingly

@github-actions github-actions bot added testing CI Related to continuous integration python Pull requests that update Python code nox Related to the nox automation software labels May 17, 2024
@github-actions github-actions bot added the packaging Related to packaging or distribution label May 17, 2024
Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.25%. Comparing base (9340245) to head (f21d01d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2695   +/-   ##
=======================================
  Coverage   95.25%   95.25%           
=======================================
  Files         104      104           
  Lines        9435     9435           
  Branches     2159     2159           
=======================================
  Hits         8987     8987           
  Misses        272      272           
  Partials      176      176           

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

@github-actions github-actions bot added the maintenance General updates to package infrastructure label May 17, 2024
@namurphy namurphy marked this pull request as ready for review May 17, 2024 20:20
@namurphy namurphy requested a review from a team as a code owner May 17, 2024 20:20
@namurphy namurphy requested review from pheuer and removed request for a team May 17, 2024 20:20
@github-actions github-actions bot added the GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) label May 17, 2024
Comment on lines +67 to +71
- name: Check MANIFEST.in
os: ubuntu-latest
python: '3.12'
nox_session: manifest

Copy link
Member Author

Choose a reason for hiding this comment

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

This makes it so that MANIFEST.in gets checked for every PR, but we can switch it to a weekly test after #2694 is merged.

Copy link
Member

@pheuer pheuer left a comment

Choose a reason for hiding this comment

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

I only about 50% understand what is going on with this tox->nox transition, but insofar as this PR defines a few new sessions for checking the manifest and running pre-commit, I think I understand and it looks good :)

@namurphy
Copy link
Member Author

Awesome, thank you for the review!

@namurphy namurphy merged commit a933be3 into PlasmaPy:main May 18, 2024
18 checks passed
@namurphy namurphy deleted the check-manifest branch May 18, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Related to continuous integration GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) maintenance General updates to package infrastructure nox Related to the nox automation software packaging Related to packaging or distribution python Pull requests that update Python code testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants