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

chore: repo review updates #408

Merged
merged 3 commits into from
Dec 23, 2023
Merged

chore: repo review updates #408

merged 3 commits into from
Dec 23, 2023

Conversation

henryiii
Copy link
Member

@henryiii henryiii commented Dec 22, 2023

  • chore: touch up Ruff config
  • chore: remove uneeded MyPy config line
  • ci: grouped dependabot updates

I ran repo-review (below) and fixed most of the issues. The warn_unreachable one I think should probably check for existence, not the True setting.

See scientific-python/cookie#348 for the grouping update.

Repo-review:

General

  • Detected build backend: hatchling.build
  • Detected license(s): BSD License
?NameDescription
PY001 Has a pyproject.toml
PY002 Has a README.(md|rst) file
PY003 Has a LICENSE* file
PY004 Has docs folder
PY005 Has tests folder
PY006 Has pre-commit config
PY007 Supports an easy task runner (nox or tox)

PyProject

?NameDescription
PP002 Has a proper build-system table
PP003 Does not list wheel as a build-dep
PP301 Has pytest in pyproject
PP302 Sets a minimum pytest to at least 6
PP303 Sets the test paths
PP304 Sets the log level in pytest
PP305 Specifies xfail_strict
PP306 Specifies strict config
PP307 Specifies strict markers
PP308 Specifies useful pytest summary
PP309 Filter warnings specified

GitHub Actions

?NameDescription
GH100 Has GitHub Actions config
GH101 Has nice names
GH102 Auto-cancel on repeated PRs
GH103 At least one workflow with manual dispatch trigger
GH104 Use unique names for upload-artifact
GH200 Maintained by Dependabot
GH210 Maintains the GitHub action versions with Dependabot
GH211 Do not pin core actions as major versions
GH212 Require GHA update grouping

Projects should group their updates to avoid extra PRs and stay in sync. This is now supported by dependabot since June 2023.

    groups:
      actions:
        patterns:
          - "*"

Pre-commit

?NameDescription
PC100 Has pre-commit-hooks
PC110 Uses black or ruff-format
PC111 Uses blacken-docs
PC140 Uses mypy
PC160 Uses codespell
PC170 Uses PyGrep hooks (only needed if RST present)
PC180 Uses prettier
PC190 Uses Ruff
PC191 Ruff show fixes if fixes enabled
PC901 Custom pre-commit CI message

MyPy

?NameDescription
MY100 Uses MyPy (pyproject config)
MY101 MyPy strict mode
MY102 MyPy show_error_codes deprecated

Must not have show_error_codes. Use hide_error_codes instead (since MyPy v0.990).

MY103 MyPy warn unreachable
MY104 MyPy enables ignore-without-code
MY105 MyPy enables redundant-expr
MY106 MyPy enables truthy-bool

Ruff

?NameDescription
RF001 Has Ruff config
RF002 Target version must be set
RF003 src directory specified if used
RF101 Bugbear must be selected
RF102 isort must be selected
RF103 pyupgrade must be selected
RF201 Avoid using deprecated config settings

extend-ignore deprecated, use ignore instead (identical)

RF202 Use (new) lint config section

extend-ignore should be set as lint.extend-ignore instead

isort should be set as lint.isort instead

per-file-ignores should be set as lint.per-file-ignores instead

select should be set as lint.select instead

typing-modules should be set as lint.typing-modules instead

unfixable should be set as lint.unfixable instead

Documentation

?NameDescription
RTD100 Uses ReadTheDocs (pyproject config)
RTD101 You have to set the RTD version number to 2
RTD102 You have to set the RTD build image
RTD103 You have to set the RTD python version

Validate-PyProject

Checks [build-system], [project], [tool.repo-review], [tool.setuptools]

?NameDescription
VPP001 Validate pyproject.toml

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
@codecov-commenter
Copy link

Codecov Report

Attention: 14 lines in your changes are missing coverage. Please review.

Comparison is base (6d4e866) 83.21% compared to head (56129cc) 83.21%.

Files Patch % Lines
src/vector/backends/_numba_object.py 42.85% 12 Missing ⚠️
src/vector/backends/awkward.py 75.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #408   +/-   ##
=======================================
  Coverage   83.21%   83.21%           
=======================================
  Files          96       96           
  Lines       11429    11429           
=======================================
  Hits         9511     9511           
  Misses       1918     1918           

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

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

Thanks, @henryiii! Looks good to me.

@henryiii henryiii merged commit d3a760d into main Dec 23, 2023
21 checks passed
@henryiii henryiii deleted the henryiii/chore/rr branch December 23, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants