mirror of
https://github.com/tofuutils/pre-commit-opentofu.git
synced 2025-10-15 17:38:54 +02:00
chore: Document functions (based on google style guide) (#317)
This commit is contained in:
parent
661a0cf346
commit
321fb16693
11 changed files with 190 additions and 8 deletions
|
|
@ -13,6 +13,18 @@ function main {
|
|||
infracost_breakdown_ "${HOOK_CONFIG[*]}" "${ARGS[*]}"
|
||||
}
|
||||
|
||||
#######################################################################
|
||||
# Wrapper around `infracost breakdown` tool which checks and compares
|
||||
# infra cost based on provided hook_config
|
||||
# Environment variables:
|
||||
# PRE_COMMIT_COLOR (string) If set to `never` - do not colorize output
|
||||
# Arguments:
|
||||
# hook_config (string with array) arguments that configure hook behavior
|
||||
# args (string with array) arguments that configure wrapped tool behavior
|
||||
# Outputs:
|
||||
# Print out hook checks status (Passed/Failed), total monthly cost and
|
||||
# diff, summary about infracost check (non-supported resources etc.)
|
||||
#######################################################################
|
||||
function infracost_breakdown_ {
|
||||
local -r hook_config="$1"
|
||||
local args
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue