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

cisagovbot · 2021-07-22T21:32: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-python-library.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 git@github.com:cisagov/hash-http-content.git hash-http-content
cd hash-http-content
git remote add skeleton https://github.com/cisagov/skeleton-python-library.git
git remote set-url --push skeleton no_push
git switch develop
git checkout -b lineage/skeleton --track origin/develop
git pull skeleton HEAD
git checkout --ours -- .github/lineage.yml
git add .github/lineage.yml
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 src/example/example.py tests/test_example.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.
Check the "Everything is cool" checkbox below:
- ✌️ The conflicts in this pull request have been resolved.
Mark this draft pull request "Ready for review".

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

This adds a hash of `setup.py` to the cache keys used in the GitHub Actions workflow for Python projects.

The other cache keys for our GHA jobs are in the format '**/<filename>' so that any file with that name is used in the repository. However, for Python packages they may have a 'setup.py' as part of their internal codebase that does not impact environment requirements. As a result we only want to use the 'setup.py' that is in the root of the repository and is used to install the package. Co-authored-by: dav3r <david.redmin@trio.dhs.gov>

Add rules to enforce ATX-closed headers, dashes for unordered list elements, and `1.` for ordered list elements.

Add <h1> and <img> tags to the allowed list for MD033 (HTML elements) to support using an image as the first thing in a markdown file (header image).

This converts the existing `.mdl_config.json` file to an equivalent `.mdl_config.yaml` file. The reference in the markdownlint pre-commit hook configuration is updated to match. Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov>

Now that this is a YAML file we can add comments explaining the rule modifications we use. This will make it easier to edit or expand in the future.

This hook will validate any pre-commit hook manifest files in the repository.

…orrectly See the discussion here for more context: cisagov/pe-reports#6 (comment)

We should be doing this because the Packer and Terraform pre-commit hooks leverage the corresponding executables; therefore, it makes sense to go ahead and install the particular versions of those executables that we support. Also add support for optionally debugging via tmate. See also cisagov/skeleton-generic#74.

Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

There is no reason to create /usr/bin/terraform. This is a vestige of an earlier age. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

The Terraform installation does not destroy the existing system Terraform installation, and neither should the Packer installation. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Note that this change is dependent on the merging of cisagov/setup-env-github-action#31. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Some variables defined in the go installation are used in the cache task, so the go installation must happen first. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

As of [Go 1.16](https://tip.golang.org/doc/go1.16#go-command) the `GO111MODULE` environment variable defaults to `on` and `go get` has been deprecated for module installation. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

The `shfmt` tool does not ship on the GitHub Actions runners so we must install it manually.

We have had a difficult time with how beautysh parses some shellscripts. I went in pursuit of an alternative and I believe shfmt to be a good alternative. Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov>

This package has a `__main__.py` file which removes the need to include this boilerplate.

Instead of returning a value the main loop should explicitly call `sys.exit()` if an error is encountered that would result in a non-zero exit code.

The type hints for the example_div function indicate it takes two float values, but the command line interface indicates (and checks) that it takes integer values.

C-style '%' formatting should be used to any calls to the `logging` library.

The testing needs to be updated now that `example.main()` only returns a `None` and error exits are done by directly calling `sys.exit()`.

This is performed by running `pre-commit autoupdate`, but with the `ansible-lint` hook held back manually.

Update pre-commit Hooks

Add the validate_manifest Hook to pre-commit Configuration

⚠️ CONFLICT! Lineage pull request for: skeleton

…tion

…onfiguration Standardize the Layout of the Lineage Configuration File

Verify that the logging level for the root logger is set correctly

…preferences

…lopment_preferences Update to Match Best Practices

…e_key Add setup.py to the Cache Keys for the GitHub Actions Workflow

jsf9k

Looks great to me!

(I had already pre-reviewed, hence the rapid turnaround.)

dav3r

👍 👍

mcdonnnj and others added 30 commits June 7, 2021 07:46

Standardize the layout of the Lineage configuration file

4baa1ed

Add to the cache keys for the GitHub Actions workflow

249bbbb

This adds a hash of `setup.py` to the cache keys used in the GitHub Actions workflow for Python projects.

Add style enforcement rules

1e8f822

Add rules to enforce ATX-closed headers, dashes for unordered list elements, and `1.` for ordered list elements.

Add rule for image headers

afc6bd6

Add <h1> and <img> tags to the allowed list for MD033 (HTML elements) to support using an image as the first thing in a markdown file (header image).

Switch to a YAML markdownlint configuration file

ce173f4

This converts the existing `.mdl_config.json` file to an equivalent `.mdl_config.yaml` file. The reference in the markdownlint pre-commit hook configuration is updated to match. Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov>

Add comments to markdownlint configuration

f2a4230

Now that this is a YAML file we can add comments explaining the rule modifications we use. This will make it easier to edit or expand in the future.

Add the validate_manifest hook from pre-commit

d4781ee

This hook will validate any pre-commit hook manifest files in the repository.

Add assertion to verify that the root logger's logging level is set c…

7ae8bea

…orrectly See the discussion here for more context: cisagov/pe-reports#6 (comment)

Break out the curl cache creation into its own step

c481043

Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Remove unnecessary line in tasks

70414cf

There is no reason to create /usr/bin/terraform. This is a vestige of an earlier age. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Modify the Packer installation to model that of Terraform

b629f7f

The Terraform installation does not destroy the existing system Terraform installation, and neither should the Packer installation. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Install a specific version of terraform-docs

181d1b2

Note that this change is dependent on the merging of cisagov/setup-env-github-action#31. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Move go installation so that it takes place before the cache task

bb6e566

Some variables defined in the go installation are used in the cache task, so the go installation must happen first. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Capitalize Go for consistency

337d1ef

Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Prefer the newer "go install" syntax

8ee2116

As of [Go 1.16](https://tip.golang.org/doc/go1.16#go-command) the `GO111MODULE` environment variable defaults to `on` and `go get` has been deprecated for module installation. Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>

Install the shfmt tool for GHA

e2a729d

The `shfmt` tool does not ship on the GitHub Actions runners so we must install it manually.

Replace the beautysh hook with pre-commit-shfmt

406b688

We have had a difficult time with how beautysh parses some shellscripts. I went in pursuit of an alternative and I believe shfmt to be a good alternative. Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov>

Apply changes from the shfmt pre-commit hook

2b48e75

Remove unnecessary boilerplate

1df1757

This package has a `__main__.py` file which removes the need to include this boilerplate.

Explicitly call sys.exit for errors

ad5009c

Instead of returning a value the main loop should explicitly call `sys.exit()` if an error is encountered that would result in a non-zero exit code.

Update function type hints

8a8785d

The type hints for the example_div function indicate it takes two float values, but the command line interface indicates (and checks) that it takes integer values.

Do not use f-strings in logging messages

29ade6f

C-style '%' formatting should be used to any calls to the `logging` library.

Update testing for exit code changes

015d47e

The testing needs to be updated now that `example.main()` only returns a `None` and error exits are done by directly calling `sys.exit()`.

Update pre-commit hooks

1708b5c

This is performed by running `pre-commit autoupdate`, but with the `ansible-lint` hook held back manually.

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

d7dcfee

Update pre-commit Hooks

Merge branch 'develop' into improvement/add_pre-commit_hook

c17800a

Merge pull request #80 from cisagov/improvement/add_pre-commit_hook

41a5286

Add the validate_manifest Hook to pre-commit Configuration

Merge branch 'develop' into improvement/update_mdl_configuration

e607360

mcdonnnj added 9 commits July 22, 2021 15:35

Merge pull request #82 from cisagov/lineage/skeleton

0efaf16

⚠️ CONFLICT! Lineage pull request for: skeleton

Merge branch 'develop' into improvement/standardize_lineage_configura…

6610849

…tion

Merge pull request #77 from cisagov/improvement/standardize_lineage_c…

720ecdc

…onfiguration Standardize the Layout of the Lineage Configuration File

Merge branch 'develop' into improvement/improve-test

9706b8b

Merge pull request #80 from cisagov/improvement/improve-test

422f11e

Verify that the logging level for the root logger is set correctly

Merge branch 'develop' into improvement/changes_to_match_development_…

d9f689f

…preferences

Merge pull request #81 from cisagov/improvement/changes_to_match_deve…

3c9b5d7

…lopment_preferences Update to Match Best Practices

Merge branch 'develop' into improvement/add_setup_to_gha_cache_key

82c3fad

Merge pull request #78 from cisagov/improvement/add_setup_to_gha_cach…

30b1756

…e_key Add setup.py to the Cache Keys for the GitHub Actions Workflow

cisagovbot assigned dav3r, felddy, jsf9k and mcdonnnj Jul 22, 2021

cisagovbot added the upstream update This issue or pull request pulls in upstream updates label Jul 22, 2021

jsf9k unassigned felddy, jsf9k and dav3r Jul 23, 2021

mcdonnnj force-pushed the lineage/skeleton branch from 228b983 to ecadd65 Compare August 4, 2021 16:31

mcdonnnj added 3 commits August 4, 2021 12:31

Merge github.com:cisagov/skeleton-python-library into lineage/skeleton

ecadd65

Reformat script with the shfmt tool

7a641dc

Fix unordered list style in README

b7293a7

mcdonnnj marked this pull request as ready for review August 4, 2021 17:30

mcdonnnj requested review from dav3r, felddy, jsf9k and mcdonnnj as code owners August 4, 2021 17:30

jsf9k approved these changes Aug 4, 2021

View reviewed changes

dav3r approved these changes Aug 4, 2021

View reviewed changes

mcdonnnj merged commit c781cab into develop Aug 4, 2021

mcdonnnj deleted the lineage/skeleton branch August 4, 2021 17:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

cisagovbot commented Jul 22, 2021 •

edited by mcdonnnj

jsf9k left a comment

dav3r left a comment

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

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

Conversation

cisagovbot commented Jul 22, 2021 • edited by mcdonnnj

Lineage Pull Request: CONFLICT

How to resolve the conflicts

jsf9k left a comment

Choose a reason for hiding this comment

dav3r left a comment

Choose a reason for hiding this comment

cisagovbot commented Jul 22, 2021 •

edited by mcdonnnj