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

cisagovbot · 2024-04-30T19:17:54Z

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-generic.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/XFD.git XFD
cd XFD
git remote add skeleton https://github.com/cisagov/skeleton-generic.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 CONTRIBUTING.md 
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 future TODOs are captured in issues, which are referenced
in code comments.
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.
Finalize version.

✅ Post-merge checklist

Remove any of the following that do not apply.

Create a 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]>

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]>

If the Python version exists then we want the script to continue execution.

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

This is done automatically with the `pre-commit autoupdate` command. The pre-commit/mirrors-prettier was manually held back because the latest tags are for alpha releases of the next major version.

The hook is manually updated to the last v3 tag available from the pre-commit/mirrors-prettier repository. We then add the latest release of v3 available from NPM as an additional depdency.

…max/ghaction-github-status-4 Bump crazy-max/ghaction-github-status from 3 to 4

…abel-sync-workflow Add a diagnostics job for the label syncing workflow

…-configs Make the dev team the owners of the linter configuration files

…orp/setup-terraform-3 Bump hashicorp/setup-terraform from 2 to 3

…_queues Improve merge queue support

…s/setup-go-5 Bump actions/setup-go from 4 to 5

…s/setup-python-5 Bump actions/setup-python from 4 to 5

Update `pre-commit` hooks

…steps Set the default `shell` for all `run` steps in the `build` workflow

…pecify_python Allow setup-env to specify Python version

…om_action Use `cisagov/setup-env-github-action` to provide the Python and Go versions to use

…ok_for_shfmt Switch the pre-commit hook used to run `shfmt`

Add a pre-commit hook to run `goimports`

…upport_terraform-docs Add ATX Header Support for `terraform-docs`

This hook bundles the binaries for shellcheck with a Python package which removes the need to ensure the tool is installed for the hook to function. It also ties the version of shellcheck used to the hook which will help guarantee consistency.

…ok_for_shellcheck Switch the pre-commit hook used to run `shellcheck`

# Conflicts: # .github/workflows/build.yml # .pre-commit-config.yaml # CONTRIBUTING.md

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]>

Move misplaced exit

9497dc2

If the Python version exists then we want the script to continue execution.

Michael Saki and others added 23 commits February 28, 2024 16:03

Improve verbiage in comment

01abde6

Change comments for macOS and venv_name

0989d17

Improve comments for clarity

a9c6ed8

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

Update pre-commit hook versions

b9c729f

This is done automatically with the `pre-commit autoupdate` command. The pre-commit/mirrors-prettier was manually held back because the latest tags are for alpha releases of the next major version.

Manually update the prettier hook

4c93395

The hook is manually updated to the last v3 tag available from the pre-commit/mirrors-prettier repository. We then add the latest release of v3 available from NPM as an additional depdency.

Merge pull request #149 from cisagov/dependabot/github_actions/crazy-…

9a0e7c3

…max/ghaction-github-status-4 Bump crazy-max/ghaction-github-status from 3 to 4

Merge pull request #150 from cisagov/improvement/add-diagnostics-to-l…

d0d8783

…abel-sync-workflow Add a diagnostics job for the label syncing workflow

Merge pull request #151 from cisagov/improvement/make-ois-own-linting…

158abf5

…-configs Make the dev team the owners of the linter configuration files

Merge pull request #155 from cisagov/dependabot/github_actions/hashic…

6f23c97

…orp/setup-terraform-3 Bump hashicorp/setup-terraform from 2 to 3

Merge pull request #156 from cisagov/improvement/better_support_merge…

c0043bd

…_queues Improve merge queue support

Merge pull request #158 from cisagov/dependabot/github_actions/action…

e5ffc52

…s/setup-go-5 Bump actions/setup-go from 4 to 5

Merge pull request #159 from cisagov/dependabot/github_actions/action…

59b2ad1

…s/setup-python-5 Bump actions/setup-python from 4 to 5

Merge pull request #161 from cisagov/maintenance/update_pre-commit_hooks

57bef4a

Update `pre-commit` hooks

Merge pull request #162 from cisagov/improvement/set_default_for_run_…

01c9e11

…steps Set the default `shell` for all `run` steps in the `build` workflow

Merge pull request #166 from cisagov/improvement/allow_setup-env_to_s…

d1a186d

…pecify_python Allow setup-env to specify Python version

Use Python and Go versions provided by cisagov/setup-env-github-action

7169dcf

Merge pull request #157 from cisagov/improvement/get_more_versions_fr…

95a61f5

…om_action Use `cisagov/setup-env-github-action` to provide the Python and Go versions to use

Merge pull request #160 from cisagov/improvement/switch_pre-commit_ho…

81735c2

…ok_for_shfmt Switch the pre-commit hook used to run `shfmt`

Merge pull request #163 from cisagov/improvement/add_goimports_hook

4f73489

Add a pre-commit hook to run `goimports`

Merge pull request #164 from cisagov/improvement/install_atx_header_s…

9020b55

…upport_terraform-docs Add ATX Header Support for `terraform-docs`

Merge pull request #168 from cisagov/improvement/switch_pre-commit_ho…

e79569c

…ok_for_shellcheck Switch the pre-commit hook used to run `shellcheck`

Merge https://github.com/cisagov/skeleton-generic into lineage/skeleton

5276f55

# Conflicts: # .github/workflows/build.yml # .pre-commit-config.yaml # CONTRIBUTING.md

cisagovbot assigned aloftus23, cduhn17, Matthew-Grayson, nickviola, rapidray12 and schmelz21 Apr 30, 2024

cisagovbot added the upstream update This issue or pull request pulls in upstream updates label Apr 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

cisagovbot commented Apr 30, 2024

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

Are you sure you want to change the base?

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

Conversation

cisagovbot commented Apr 30, 2024

Lineage Pull Request: CONFLICT

How to resolve the conflicts

✅ Pre-approval checklist

✅ Pre-merge checklist

✅ Post-merge checklist