⚠️ CONFLICT! Lineage pull request for: skeleton #106

cisagovbot · 2024-12-06T23:26:19Z

Lineage Pull Request: CONFLICT

Lineage has created this pull request to incorporate new changes found in an
upstream repository:

Upstream repository: https://github.com/cisagov/skeleton-docker.git
Remote branch: HEAD

Check the changes in this pull request to ensure they won't cause issues with
your project.

The lineage/skeleton branch has one or more unresolved merge conflicts
that you must resolve before merging this pull request!

How to resolve the conflicts

Take ownership of this pull request by removing any other assignees.

Clone the repository locally, and reapply the merge:

git clone [email protected]:cisagov/vdp-scanner-docker.git vdp-scanner-docker
cd vdp-scanner-docker
git remote add skeleton https://github.com/cisagov/skeleton-docker.git
git remote set-url --push skeleton no_push
git switch develop
git switch --create lineage/skeleton --track origin/develop
git pull skeleton HEAD
git status

Review the changes displayed by the status command. Fix any conflicts and
possibly incorrect auto-merges.
After resolving each of the conflicts, add your changes to the
branch, commit, and push your changes:
```
git add .github/workflows/build.yml .pre-commit-config.yaml Dockerfile README.md docker-compose.yml requirements-dev.txt src/Pipfile src/Pipfile.lock src/version.txt tests/container_test.py 
git commit
git push --force --set-upstream origin lineage/skeleton
```
Note that you may append to the default merge commit message
that git creates for you, but please do not delete the existing
content. It provides useful information about the merge that is
being performed.
Wait for all the automated tests to pass.
Confirm each item in the "Pre-approval checklist" below.
Remove any of the checklist items that do not apply.
Ensure every remaining checkbox has been checked.
Mark this draft pull request "Ready for review".

✅ Pre-approval checklist

Remove any of the following that do not apply. If you're unsure about
any of these, don't hesitate to ask. We're here to help!

✌️ The conflicts in this pull request have been resolved.
All relevant type-of-change labels have been added.
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

Remove any of the following that do not apply. These boxes should
remain unchecked until the pull request has been approved.

Bump major, minor, patch, or pre-release version as
appropriate
via the bump_version.sh script if this repository is
versioned and the changes in this PR warrant a version
bump.

✅ Post-merge checklist

Remove any of the following that do not apply.

Create a pre-release.

Note

You are seeing this because one of this repository's maintainers has
configured Lineage to open pull requests.

For more information:

🛠 Lineage configurations for this project are stored in .github/lineage.yml

📚 Read more about Lineage

Bumps [crazy-max/ghaction-github-status](https://github.com/crazy-max/ghaction-github-status) from 3 to 4. - [Release notes](https://github.com/crazy-max/ghaction-github-status/releases) - [Commits](crazy-max/ghaction-github-status@v3...v4) --- updated-dependencies: - dependency-name: crazy-max/ghaction-github-status dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Also add a runner hardening task to the labeler job.

Co-authored-by: Nick <[email protected]>

…up-env files Co-authored-by: Nick <[email protected]>

@mcdonnnj

@mcdonnnj correctly pointed out that other projects add their own configuration files that match, e.g., the /.*.yaml pattern. We want to ensure that we only own the linter configuration files from the skeleton. Co-authored-by: Nick <[email protected]>

Bumps [hashicorp/setup-terraform](https://github.com/hashicorp/setup-terraform) from 2 to 3. - [Release notes](https://github.com/hashicorp/setup-terraform/releases) - [Changelog](https://github.com/hashicorp/setup-terraform/blob/main/CHANGELOG.md) - [Commits](hashicorp/setup-terraform@v2...v3) --- updated-dependencies: - dependency-name: hashicorp/setup-terraform dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

We prefer block style to flow style for sequences and mappings in YAML.

We prefer to alphabetize mapping keys in YAML documents whenever possible.

This should improve compatibility with merge queues. We configure it to only trigger on the `checks_requested` type which is currently the only supported type for this trigger. If additional types are added in the future they should be added if appropriate.

Bumps [actions/setup-go](https://github.com/actions/setup-go) from 4 to 5. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](actions/setup-go@v4...v5) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](actions/setup-python@v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v2...v3) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

This hook bundles the binaries for shfmt with a Python package which removes the need to manually install the tool for the hook to function.

The new pre-commit hook provides `shfmt` binaries so we no longer need to ensure it is installed.

Since shfmt now supports long command line options we should use them as that is our preference. The single quotes for the number of spaces to indent is changed to double quotes to align with our usual quotation style.

These options are baked into the functionality of the old hook but must be explicitly declared for the new hook.

This sets the default shell for any run steps in the build workflow to mirror our standard shellscript writing practices. In addition to enabling our standard options it will also enable errtrace and print any commands that are run which should make debugging/troubleshooting more straightforward.

This will run the Go tool `goimports` against the repository if it contains any Go files. This tool bundles the functionality of `go fmt` with the additional benefit of sorting Go imports much like the isort tool we use for Python code.

@mcdonnnj

This is a temporary fix until @mcdonnnj has his PR approved and merged into the terraform-docs repo. This fix will perform a shallow clone of his forked branch, build the binary, and install it.

Co-authored-by: Nick <[email protected]>

Co-authored-by: Shane Frasier <[email protected]>

PATH is handled by `setup-go` so we can refactor the code setting it. Also we are taking advantage of the -C switch to handle building from the cloned repository. Co-authored-by: Nick <[email protected]>

`TODO` was placed on the wrong comment block. Also I am adding a link to the issue for the TODO.

Co-authored-by: dav3r <[email protected]>

This commit is introducing 2 new flags into the setup-env script. -l or --list-versions will list available Python versions and allow the user to select a version interactively. The second flag -v or --version will allow a user to set the version if installed. (e.g. ./setup-env -v 3.9.6)

This makes the code a bit cleaner and still accomplishes the same functionality Co-authored-by: Shane Frasier <[email protected]>

Co-authored-by: Shane Frasier <[email protected]>

Use the `docker/metadata-action` GitHub Action to generate our image metadata

Python 3.11.8 is no longer available for Alpine Linux 3.18. We update the system package version installed in `compile-stage` to the version of Python currently available for Alpine Linux 3.18. However, there is no equivalent `python` Docker image available for Alpine Linux 3.18. As a result we must upgrade to Alpine Linux 3.19, which fortunately has the same version of Python available as a system package.

Update the Pipfile to require the version of Python currently used in the Docker configuration. This includes re-locking the Pipfile with `pipenv lock` in the `src/` directory.

Ensure all system packages installed in the Docker configuration are the latest versions available for Alpine Linux 3.18: - ca-certificates from 20240226-r0 to 20241121-r1 - chromium from 119.0.6045.159-r0 to 124.0.6367.78-r0 - gcc from 12.2.1_git20220924-r10 to 13.2.1_git20231014-r0 - libxml2 from 2.11.7-r00 to 2.11.8-r0 - libxml2-dev from 2.11.7-r00 to 2.11.8-r0 - libxslt from1.1.38-r0 to 1.1.39-r0 - libxslt-dev from 1.1.38-r0 to 1.1.39-r0 - py3-pip from 23.1.2-r0 to 23.3.1-r0 - py3-setuptools from 67.7.2-r0 to 70.3.0-r0

The version of Python installed as a system package is marked as externally managed per PEP 668 and the pipenv Python package is not available as a system package. Therefore we need to create a venv for the Python packages we use for setup (pip, setuptools, wheel, and pipenv).

Since the format of the version storing file has changed we must update this function.

I am seeing problems building a wheel for the `lxml` package when the Docker image is build for armv7 in GitHub Actions. It appears to be failing with the following error: virtual memory exhausted: Out of memory Compile failed: command '/usr/bin/gcc' failed with exit code 1 Since there is no way for us to increase the memory on the free GitHub Action runners we currently rely on this is the sanest (to me) workaround. The system packages that are installed to build the `lxml` package on platforms that do not have a wheel available from PyPI are removed as part of this change.

jsf9k

Approved, with one question and one minor suggestion.

README.md

requirements-dev.txt

dependabot bot and others added 30 commits September 13, 2023 02:01

Add a diagnostics job for the label syncing workflow

371179e

Also add a runner hardening task to the labeler job.

Make the dev team the owners of the linter configuration files

1f611fc

Co-authored-by: Nick <[email protected]>

Make dev team members the codeowners of the requirements*.txt and set…

c356768

…up-env files Co-authored-by: Nick <[email protected]>

Prefer block style to flow style

9f31700

We prefer block style to flow style for sequences and mappings in YAML.

Alphabetize entries in the build workflow

696433a

We prefer to alphabetize mapping keys in YAML documents whenever possible.

Switch pre-commit hooks for running shfmt

4a63dbe

This hook bundles the binaries for shfmt with a Python package which removes the need to manually install the tool for the hook to function.

Remove installation of shfmt in the build workflow

3236b1b

The new pre-commit hook provides `shfmt` binaries so we no longer need to ensure it is installed.

Use long options for shfmt arguments

5ddb14d

Since shfmt now supports long command line options we should use them as that is our preference. The single quotes for the number of spaces to indent is changed to double quotes to align with our usual quotation style.

Add additional shfmt options

8ecd957

These options are baked into the functionality of the old hook but must be explicitly declared for the new hook.

Add ATX Header Support for terraform-docs

f6d9d6e

This is a temporary fix until @mcdonnnj has his PR approved and merged into the terraform-docs repo. This fix will perform a shallow clone of his forked branch, build the binary, and install it.

Add prepended names to variables to describe their function

544e478

Co-authored-by: Nick <[email protected]>

Remove unnecessary capitalizations and fix grammar

f5fa0ff

Co-authored-by: Shane Frasier <[email protected]>

Simplify steps in the build/install portion of workflow

36361dd

PATH is handled by `setup-go` so we can refactor the code setting it. Also we are taking advantage of the -C switch to handle building from the cloned repository. Co-authored-by: Nick <[email protected]>

Add TODO label

3711ebe

Move TODO and add link to the issue

d114fb4

`TODO` was placed on the wrong comment block. Also I am adding a link to the issue for the TODO.

Alphabetize switches

c907cfc

Co-authored-by: dav3r <[email protected]>

Add /dev/null and remove TMPFILE

c10929a

This makes the code a bit cleaner and still accomplishes the same functionality Co-authored-by: Shane Frasier <[email protected]>

Place flags in the correct order for -r and -p

adada40

Remove unneccessary spacing

1861b9b

Alphabetize flags and descriptions

3f623e4

Co-authored-by: Shane Frasier <[email protected]>

mcdonnnj added 8 commits January 12, 2025 10:01

Merge pull request #207 from cisagov/improvement/use_metadata-action

7a5cddf

Use the `docker/metadata-action` GitHub Action to generate our image metadata

Merge github.com:cisagov/skeleton-docker into lineage/skeleton

992af6b

Enable new dependabot ignore directive

6085782

Update the pipenv configuration

d1ce911

Update the Pipfile to require the version of Python currently used in the Docker configuration. This includes re-locking the Pipfile with `pipenv lock` in the `src/` directory.

Update the version extraction function

21bbe95

Since the format of the version storing file has changed we must update this function.

mcdonnnj force-pushed the lineage/skeleton branch 2 times, most recently from 1a2f14e to 1a6a8cb Compare January 13, 2025 22:14

mcdonnnj added 2 commits January 13, 2025 19:11

Bump version from 0.2.0-dev.4 to 0.2.0-dev.5

a1e69b8

mcdonnnj force-pushed the lineage/skeleton branch from 1a6a8cb to a1e69b8 Compare January 14, 2025 00:14

mcdonnnj marked this pull request as ready for review January 14, 2025 18:28

mcdonnnj requested review from dav3r, felddy, jsf9k and mcdonnnj as code owners January 14, 2025 18:28

mcdonnnj requested a review from a team January 14, 2025 18:46

dv4harr10 approved these changes Jan 14, 2025

View reviewed changes

jsf9k approved these changes Jan 14, 2025

View reviewed changes

README.md Show resolved Hide resolved

requirements-dev.txt Show resolved Hide resolved

dav3r approved these changes Jan 15, 2025

View reviewed changes

mcdonnnj merged commit 4771fcf into develop Jan 16, 2025
23 checks passed

mcdonnnj deleted the lineage/skeleton branch January 16, 2025 05:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ CONFLICT! Lineage pull request for: skeleton #106

⚠️ CONFLICT! Lineage pull request for: skeleton #106

cisagovbot commented Dec 6, 2024 •

edited by mcdonnnj

Loading

jsf9k left a comment

⚠️ CONFLICT! Lineage pull request for: skeleton #106

⚠️ CONFLICT! Lineage pull request for: skeleton #106

Conversation

cisagovbot commented Dec 6, 2024 • edited by mcdonnnj Loading

Lineage Pull Request: CONFLICT

How to resolve the conflicts

✅ Pre-approval checklist

✅ Pre-merge checklist

✅ Post-merge checklist

jsf9k left a comment

Choose a reason for hiding this comment

cisagovbot commented Dec 6, 2024 •

edited by mcdonnnj

Loading