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

Modernize the project #41

Merged
merged 424 commits into from
Mar 17, 2023
Merged

Modernize the project #41

merged 424 commits into from
Mar 17, 2023

Conversation

mcdonnnj
Copy link
Member

@mcdonnnj mcdonnnj commented Mar 17, 2023

🗣 Description

This pull request modernizes the configuration of this project and updates its parent repo from cisagov/skeleton-generic to cisagov/skeleton-docker.

💭 Motivation and context

Important reasons to update this project include:

  • Since this is a Docker project it should descend from cisagov/skeleton-docker.
  • We no longer use TravisCI.
  • It's good to be up-to-date with our development practices.

The driving reason for updating this project however is that we need an image built with a newer version of boto3 to support using this image on an EC2 instances using IMDSv2 for IAM access.

This particular pull request is a collective including the following individual changes:

🧪 Testing

Automated tests pass. I have verified that I am able to generate a "good" code.json with the current pre-release version.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge checklist

  • Finalize version.

✅ Post-merge checklist

  • Create a release.

mcdonnnj and others added 30 commits November 18, 2020 16:47
Add Python Version Missing from actions/cache Key
⚠️ CONFLICT! Lineage pull request for: skeleton
Make sure all actions/cache steps are in-line with the changes made to the lint
job's step.
Lineage pull request for: skeleton
⚠️ CONFLICT! Lineage pull request for: skeleton
Our other skeletons have this file, even if they are not Python projects. The
directions in CONTRIBUTING.md reference such a file, which can be misleading.
Rather than amending the CONTRIBUTING documentation, I feel it's better to
align with our other skeletons for consistency.
Lineage pull request for: skeleton
Correct the Agency Name for Docker Images
Add a requirements-dev.txt pip Requirements File
I noticed the following warning when looking at GHA workflow runs:

1 issue was detected with this workflow: git checkout HEAD^2 is no longer
necessary. Please remove this step as Code Scanning recommends analyzing the
merge commit for best results.

After looking into it I updated the workflow per this page on GitHub Docs:

https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow#warning-git-checkout-head2-is-no-longer-necessary
Update CodeQL Workflow for GitHub Actions
* Duplicates DockerHub tags for ghcr.io
* Adds login to GitHub Container Registry using the GITHUB_TOKEN secret.
* Documentation update to reflect multi-registry publication.
* Add instructions for cross-platform builds
* Clean up shields
* Clean up tables for each Docker configuration item
* Add section about supported tags
This should resolve the following error:

Error: Workflows triggered by Dependabot on the "push" event run with read-only
access. Uploading Code Scanning results requires write access. To use Code
Scanning with Dependabot, please ensure you are using the "pull_request" event
for this workflow and avoid triggering on the "push" event for Dependabot
branches. See
https://docs.github.com/en/code-security/secure-coding/configuring-code-scanning#scanning-on-push
for more information on how to configure these events.
Co-authored-by: Hillary <[email protected]>
Co-authored-by: Hillary <[email protected]>
Co-authored-by: Hillary <[email protected]>
Co-authored-by: Hillary <[email protected]>
Co-authored-by: Hillary <[email protected]>
mcdonnnj and others added 13 commits March 9, 2023 19:11
This ensures expected behavior by running the file as a Python script
instead of executing the file and allowing bash to resolve how it runs.
Makes sure that the pip, pipenv, and setuptools packages installed are
the latest version.
Update the dependencies installed in the Python virtual environment by
running `pipenv lock` in the `src/` directory.
Remove unnecessary capitalization and fix a typo in a package name.

Co-authored-by: dav3r <[email protected]>
This fork includes changes that we need but are not present in the
upstream project at this time. The version specification for the
llnl-scraper package is updated in the Pipfile and the configuration
is re-locked to update the lockfile.
…lnl-scraper

Use `cisagov/scraper` instead of `llnl-scraper` from PyPI
@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use upstream update This issue or pull request pulls in upstream updates version bump This issue or pull request increments the version number dependencies Pull requests that update a dependency file labels Mar 17, 2023
@mcdonnnj mcdonnnj requested review from dav3r, felddy and jsf9k as code owners March 17, 2023 15:33
@mcdonnnj mcdonnnj self-assigned this Mar 17, 2023
@github-advanced-security
Copy link

You have successfully added a new CodeQL configuration .github/workflows/codeql-analysis.yml:analyze/language:python. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

👍 👍 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use upstream update This issue or pull request pulls in upstream updates version bump This issue or pull request increments the version number
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants