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

DAOS-9910 pre-commit hooks #19

Merged
merged 4 commits into from
Feb 25, 2022
Merged

DAOS-9910 pre-commit hooks #19

merged 4 commits into from
Feb 25, 2022

Conversation

markaolson
Copy link
Contributor

Added configuration files for

pre-commit
tflint
tfdocs
Added tools/autodoc/terraform_docs.sh which is also used in HPC Toolkit to auto generate documentation in README.md for terraform modules.

Added docs/development.md which contains information about installing pre-commit and dependencies and how to install the pre-commit hooks.

Added link to docs/development.md on the main readme

Signed-off-by: Mark A. Olson [email protected]

Added configuration files for

pre-commit
tflint
tfdocs
Added tools/autodoc/terraform_docs.sh which is also used in HPC Toolkit to auto generate documentation in README.md for terraform modules.

Added docs/development.md which contains information about installing pre-commit and dependencies and how to install the pre-commit hooks.

Added link to docs/development.md on the main readme

Signed-off-by: Mark A. Olson <[email protected]>
For MacOS users it's not optional to install findutils and coreutils.

The pre-commit hooks in this repo do not work on MacOS unless those packages
are installed.  Therefore we need to remove the word OPTIONAL.

Signed-off-by: Mark A. Olson <[email protected]>
Copy link
Contributor

@lsitkiew lsitkiew left a comment

Choose a reason for hiding this comment

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

Looks like README files have some duplicated content when terraform-docs was enabled.

Mark A. Olson added 2 commits February 18, 2022 09:47
Also fixed tflint command in docs/development.md

Signed-off-by: Mark A. Olson <[email protected]>
Copy link
Contributor

@lsitkiew lsitkiew left a comment

Choose a reason for hiding this comment

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

Code looks good

@markaolson markaolson merged commit 1951282 into daos-stack:develop Feb 25, 2022
@markaolson markaolson deleted the DAOS-9910_pre-commit branch February 25, 2022 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants