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

Add terraform-docs version #31

Merged
merged 6 commits into from
Jul 13, 2021
Merged

Add terraform-docs version #31

merged 6 commits into from
Jul 13, 2021

Conversation

jsf9k
Copy link
Member

@jsf9k jsf9k commented Jul 11, 2021

πŸ—£ Description

This pull request adds a terraform-docs version to entrypoint.sh.

πŸ’­ Motivation and context

See this pull request comment.

πŸ§ͺ Testing

All pre-commit hooks pass.

βœ… 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.
  • All new and existing tests pass.

@jsf9k jsf9k added blocked This issue or pull request is awaiting the outcome of another issue or pull request improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels Jul 11, 2021
@jsf9k jsf9k self-assigned this Jul 11, 2021
@jsf9k jsf9k force-pushed the improvement/add-terraform-docs branch from 4007f32 to d130605 Compare July 11, 2021 02:36
@jsf9k jsf9k marked this pull request as ready for review July 11, 2021 02:37
jsf9k added a commit to cisagov/skeleton-generic that referenced this pull request Jul 11, 2021
Note that this change is dependent on the merging of
cisagov/setup-env-github-action#31.

Co-authored-by: Nick M. <[email protected]>
@jsf9k jsf9k removed the blocked This issue or pull request is awaiting the outcome of another issue or pull request label Jul 11, 2021
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.

Thanks for taking care of this side! Some great improvement and it's good to get this under version control for consistency. Just one fix and I should be good to approve this PR.

entrypoint.sh Outdated Show resolved Hide resolved
The terraform-docs version starts with a `v` character.

Co-authored-by: Nick M. <[email protected]>
@jsf9k jsf9k requested a review from mcdonnnj July 12, 2021 01:58
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.

Excellent work! I threw this into a workflow in my personal GHA testing repo and it looks like everything installs as expected:

packer --version
terraform --version
terraform-docs --version
shell: /usr/bin/bash -e {0}
env:
  CURL_CACHE_DIR: ~/.cache/curl
  PIP_CACHE_DIR: ~/.cache/pip
  PRE_COMMIT_CACHE_DIR: ~/.cache/pre-commit
  RUN_TMATE: 
  PACKER_VERSION: 1.6.6
  TERRAFORM_VERSION: 0.12.31
  TERRAFORM_DOCS_VERSION: v0.14.1
  pythonLocation: /opt/hostedtoolcache/Python/3.9.5/x64
  LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.9.5/x64/lib
  GOROOT: /opt/hostedtoolcache/go/1.16.5/x64
  GO_VERSION: 1.16.5
1.6.6
Terraform v0.12.31

Your version of Terraform is out of date! The latest version
is 1.0.2. You can update by downloading from https://www.terraform.io/downloads.html
terraform-docs version v0.14.1 linux/amd64

Nice shades Frasier!

@jsf9k
Copy link
Member Author

jsf9k commented Jul 12, 2021

Nice shades Frasier!

Thanks for testing it. πŸ™‡β€β™‚οΈ

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.

Yessir, I like this! πŸ‘

@jsf9k jsf9k merged commit c7faeb7 into develop Jul 13, 2021
@jsf9k jsf9k deleted the improvement/add-terraform-docs branch July 13, 2021 20:01
Sallenmoore pushed a commit to Sallenmoore/foundryvtt-docker that referenced this pull request Jun 18, 2023
Note that this change is dependent on the merging of
cisagov/setup-env-github-action#31.

Co-authored-by: Nick M. <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants