Merged
Conversation
ericof
approved these changes
Jun 18, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces the following changes:
safetyis automatically run locally only against a single Python version. In CI it will continue to run on all Python versions.safety's default telemetry is now disabled.Improvement opportunities found during this work
The linting tests in CI are considered required. However, pre-commit.ci now handles linting. The CI configuration needs to be updated.
Linting currently fails on Windows; it appears that
.gitattributesis forcing platform-specific line endings that override developer git settings and cause the doc8 hook to fail all files. This can be addressed in a different PR.When building the documentation,
mystsphinx_contrib.apidoc consistently overwritesdocs/cookiecutter.rstwith slightly different contents than what's stored in git.This can be addressed in a different PR.I don't currently see a way to fix this via the apidoc configuration.pytest reports a UserWarning during execution; this should be caught by the test that induces it, rather than allowing it to bubble up to pytest. This can be addressed in a different PR.
The test suite cannot be run fully in parallel due to file access conflicts (at least on Windows). File I/O should not be occurring in the same directory across multiple runs, so it will be beneficial to update the test suite so it uses unique directories, or to virtualize all I/O using pyfakefs. This will be a helpful improvement to allow for parallel execution, rather than serial execution, of the test suite.