Pull in upstream updates #8
Merged
Conversation
This file contains 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
Update pre-commit Hooks
Per prettier/prettier#9459 and specifically prettier/prettier#9459 (comment) the prettier hook for pre-commit is being broken out into its own repo.
Change repo for the prettier pre-commit hook
⚠️ CONFLICT! Lineage pull request for: skeleton
This additional clause must remain at the _end_ of the CODEOWNERS file so that it cannot be overridden by a later clause. We want to make it so that all the .github files including CODEOWNERS are protected so only code owners (the dev team) can approve modifications to them. This will prevent configuration changes from breaking Actions and other management-type functions that the files in this directory control. By setting the .github files/folder to require code owner approval for changes, workflow and management changes will require dev team review and checking. Resolves #56.
There is no need to run python code to determine the python version. Resolves #58. See here for details: https://github.com/actions/setup-python/blob/main/action.yml#L14-L16
Sort the install_requires and extras_require["test"] arguments by key.
Group related pre-commit hooks together. Make sure that hooks are alphabetically sorted within those groups.
Switch to the file line reading version of extracting the version from https://packaging.python.org/guides/single-sourcing-package-version/ instead of the exec method on the same page. The exec method required us to use a "# nosec" to manually disable Bandit checking on that line. Although that method is more straightforward, I do not feel that it is worth using an exec in the codebase when another option is available.
Organize and Sort pre-commit Hooks
…gihub-dir Ensure that the cisagov devs are the owners of the .github directory
…re-simply Use the python version output by actions/setup-python
Also updated the test and build jobs in the build workflow to mirror cache key format changes in the lint job.
⚠️ CONFLICT! Lineage pull request for: skeleton
Sort the Package Requirements in setup.py
Remove or Explain Manual Testing Check Disables
Removed name because it was not more informative than the default. Swapped out a hardcoded job reference for the github.job context value. Switch the base cache key to a step environment value so we can set it once and reuse. Removed additional restore-key value that might have undesirable results.
Use the full semver for the installed Python version in cache keys.
Improve actions/cache Configuration
Update the comments to better mirror the current documentation for github/codeql-action. Switch to block style for the map of languages.
Clean up the commenting while we're here.
Also clean up the commenting while we're here.
Lineage pull request for: skeleton
Update the CodeQL workflow
Add dist/ to the .gitignore file to better support local building.
Modernize the build process by using the build package instead of the now deprecated setup.py install method. Remove installing the package requirements as it is unnecessary for this build process. Upgrade the setuptools package as part of the initial dependency installation.
Modernize the `build` step in the `build` workflow
As part of this the import statements are moved from the function level to the module level. This is generally considered better practice unless there is a specific reason it cannot be done at the module level.
Add some basic functionality testing for the module. Switch to importing the pymongo package directly instead of using import from to import specific objects to the module namespace.
mcdonnnj
added
improvement
dav3r
approved these changes
Jun 13, 2022
Fix some typos and capitalization that were found during review. Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Clearly explain what each configuration file that is created is supposed to test. Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
7 tasks
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.
🗣 Description
This pull request pulls in upstream updates from cisagov/skeleton-python-library which effectively re-skeletonizes the project at this point.
💭 Motivation and context
This project does not currently receive automatic updates from our Lineage process and no longer follows our current Python library development style as laid down in cisagov/skeleton-python-library. Being up to date and staying that way semi-automatically is always the best way for our actively used repositories to be.
🧪 Testing
Automates tests pass.
✅ Pre-approval checklist
to reflect the changes in this PR.
✅ Pre-merge checklist
✅ Post-merge checklist