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.

Sign up for GitHub

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

Jump to bottom

Skeletonize #63

Merged
merged 667 commits into from
Dec 5, 2022
Merged

Skeletonize #63

merged 667 commits into from
Dec 5, 2022

Conversation

jsf9k
Copy link
Member

@jsf9k jsf9k commented Oct 26, 2022 •
edited
Loading

🗣 Description

This pull request skeletonizes the repo against cisagov/skeleton-docker.

💭 Motivation and context

All of our repos that are still being used should be based on a skeleton repo.

🧪 Testing

All automated tests pass.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All future TODOs are captured in issues, which are referenced in code comments.
  • 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 June 3, 2021 11:40
@mcdonnnj
Merge branch 'develop' into improvement/readme_build_instructions
688f98b
@mcdonnnj
Merge pull request #51 from cisagov/improvement/readme_build_instruct…
b1949f9 
…ions

Add better build instructions to the README.
@mcdonnnj
Standardize the layout of the Lineage configuration file
ca4306a
@jsf9k
Update the README to reference the latest version of the Docker conta…
68948bb 
…iner

This change was discussed among @cisagov/team-ois here:
cisagov/gatherer#60 (review)

Also correct git comments to use the imperative mood.
@jsf9k @dav3r
Add a section to the README for ports
d091518 
Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
@jsf9k
Merge pull request #62 from cisagov/improvement/use-latest-version-nu…
ce74596 
…mber-in-readme

Update the README to reference the latest version of the Docker container
@jsf9k @mcdonnnj
Document the single exposed (but non-functional) port
1f6d090 
Co-authored-by: Nick M <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k
Merge pull request #61 from cisagov/documentation/add-ports-section
b1aa84c 
Add a section to the README for ports
@mcdonnnj
Add style enforcement rules
1e8f822 
Add rules to enforce ATX-closed headers, dashes for unordered list elements,
and `1.` for ordered list elements.
@mcdonnnj
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).
@mcdonnnj
Bump actions/github-script pin from v3 to v4
33a28ee
@mcdonnnj @jsf9k
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>
@mcdonnnj
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.
@mcdonnnj
Add the validate_manifest hook from pre-commit
d4781ee 
This hook will validate any pre-commit hook manifest files in the repository.
@dependabot
Bump python from 3.9-alpine to 3.9.6-alpine
52fb946 
Bumps python from 3.9-alpine to 3.9.6-alpine.

---
updated-dependencies:
- dependency-name: python
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@jsf9k
Install terraform and packer for the linting job
106af21 
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.
@jsf9k @mcdonnnj
Break out the curl cache creation into its own step
c481043 
Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
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>
@jsf9k @mcdonnnj
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>
@jsf9k @mcdonnnj
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>
@jsf9k @mcdonnnj
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>
@jsf9k @mcdonnnj
Capitalize Go for consistency
337d1ef 
Co-authored-by: Nick M. <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
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>
@mcdonnnj
Install the shfmt tool for GHA
e2a729d 
The `shfmt` tool does not ship on the GitHub Actions runners so we must install
it manually.
@mcdonnnj @jsf9k
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>
@mcdonnnj
Apply changes from the shfmt pre-commit hook
2b48e75
@dav3r
Use preferred capitalization for Docker Hub
4d37dfb
@dav3r
Satisfy linter by shortening a long line
eede87c
@dav3r
Use preferred capitalization for Docker Hub
408969a
@dav3r
Capitalize Docker in README
51076ed
jsf9k and others added 8 commits December 3, 2022 23:21
@jsf9k @mcdonnnj
Remove unused ARG
c7f3889 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Change word in comment to lowercase
b8284eb 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Create home directory when creating user
0a33921 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Remove wget
111da9a 
wget is not used, and was included as part of a copy-and-paste error.

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Install via branch tarball instead of git clone
cf476a8 
The latter only pulls what we need from the repository, whereas the former pulls the entire history.

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k
Bump version from 1.2.3 to 1.3.0
e992386
@jsf9k
Bump version from 1.3.0 to 1.3.0-rc.1
9822a01
@jsf9k
Add TODO comments for cisagov/orchestrator#130
708001f
@jsf9k jsf9k requested review from mcdonnnj and dav3r December 4, 2022 04:22
dav3r
dav3r approved these changes Dec 5, 2022
View reviewed changes
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.

👍 👍 though please fix the minor item I noted in the conversation that I reopened.

@jsf9k @dav3r
Fix version reference
2619c29 
Co-authored-by: dav3r <daver@geekpad.com>
mcdonnnj
mcdonnnj requested changes Dec 5, 2022
View reviewed changes
Copy link
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

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

Please update to the latest version (0.6.9) of pshtt for consistency since you have updated the corresponding lambda:

scanner/Dockerfile

Line 70 in 2619c29

RUN pip install --no-cache-dir --upgrade pshtt==0.6.6

@jsf9k
Copy link
Member Author

jsf9k commented Dec 5, 2022

Please update to the latest version (0.6.9) of pshtt for consistency since you have updated the corresponding lambda:

This PR is only to skeletonize the repo. As soon as this one is merged I will create a separate PR that simply updates the version of pshtt that is installed.

@jsf9k jsf9k requested a review from mcdonnnj December 5, 2022 16:31
mcdonnnj
mcdonnnj approved these changes Dec 5, 2022
View reviewed changes
Copy link
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

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

Some small (mostly documentation) items but otherwise this LGTM ✔

Dockerfile Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
jsf9k and others added 7 commits December 5, 2022 11:50
@jsf9k @mcdonnnj
Match badge to the platforms we're actually building
1d57052 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Make link text more specific
a02c58a 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Provide better link
62c1bfd 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Capitalize Docker
742fb94 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Close comment block with appropriate style
fe1aaaa 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Do not upgrade the system twice
c7faeaf 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k @mcdonnnj
Add a blurb stating why bash is required
d1d67c0 
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
@jsf9k jsf9k merged commit a9268e0 into develop Dec 5, 2022
@jsf9k jsf9k deleted the skeletonize branch December 5, 2022 17:20
@epicfaace epicfaace mentioned this pull request Dec 8, 2022
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dav3r dav3r dav3r approved these changes

@mcdonnnj mcdonnnj mcdonnnj approved these changes

@felddy felddy felddy approved these changes

Assignees

@jsf9k jsf9k

Labels
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
BOD 18-01
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jsf9k @h-m-f-t @felddy @dav3r @mcdonnnj