rshade/finfocus-action

Integrate finfocus into CI/CD workflows for cloud cost estimates

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
pulumi-plan-jsonPath to the pulumi preview --json output filenoplan.json
github-tokenGitHub Token for posting commentsno${{ github.token }}
finfocus-versionVersion of finfocus to installnolatest
install-pluginsComma-separated list of plugins to install (e.g., aws-public)no""
behavior-on-errorBehavior when an error occurs (fail, warn, silent)nofail
post-commentWhether to post a comment to the PR (true/false)notrue
fail-on-cost-increaseThreshold string (e.g., "100USD") to fail if diff exceedsno""
analyzer-modeIf true, sets up environment for pulumi preview to use as analyzernofalse
detailed-commentIf true, provides a detailed breakdown of all resources and metadata in the PR commentnofalse
include-recommendationsInclude cost optimization recommendations in PR comment (true/false)notrue
log-levelLog level for finfocus (debug, info, warn, error)noerror
debugIf true, enables detailed debug logging for the action itselfnofalse
include-actual-costsInclude actual/historical costs in PR comment (true/false)nofalse
actual-costs-periodTime period for actual costs: 7d, 30d, mtd (month-to-date), or custom YYYY-MM-DDno7d
pulumi-state-jsonPath to Pulumi state JSON for state-based cost estimationno""
actual-costs-group-byGroup actual costs by: resource, type, provider, daily, monthlynoprovider
include-sustainabilityInclude carbon footprint and sustainability metrics (true/false)notrue
utilization-rateAssumed utilization rate for sustainability calculations (0.0 to 1.0)no1.0
sustainability-equivalentsShow impact equivalents like trees, miles driven (true/false)notrue
fail-on-carbon-increaseThreshold (e.g., "10%", "10kg") to fail if carbon footprint increasesno""
budget-amountBudget amount for cost tracking (e.g., 1000)no""
budget-currencyBudget currency code (e.g., USD)noUSD
budget-periodBudget period: monthly, quarterly, yearlynomonthly
budget-alertsBudget alerts in JSON format: [{"threshold": 80, "type": "actual"}, {"threshold": 100, "type": "forecasted"}]no""
budget-alert-thresholdPercentage threshold to trigger budget alert in PR commentno80
fail-on-budget-healthFail if budget health score falls below this value (0-100)no""
show-budget-forecastDisplay budget forecast in PR commentnotrue
budget-scopesYAML multiline string of scoped budgets. Each line is "scope: amount". Scope formats: provider/aws, type/compute, tag/env:prod Example: provider/aws: 1000 provider/gcp: 500 type/compute: 1200 no""
fail-on-budget-scope-breachFail the action if any scoped budget is exceeded (true/false)nofalse
namedescription
total-monthly-costThe absolute projected monthly cost
cost-diffThe difference in cost compared to the base state
currencyThe currency code (e.g., USD)
report-json-pathPath to the generated full JSON report
policy-pack-pathPath to the set up policy pack directory
actual-total-costTotal actual cost for the specified period
actual-cost-periodThe date range for actual costs (e.g., 2025-01-01 to 2025-01-07)
total-savingsTotal potential monthly savings from recommendations
recommendation-countTotal number of cost recommendations found
total-carbon-footprintTotal estimated CO2 emissions (kgCO2e/month)
carbon-intensityCarbon intensity per dollar spent (gCO2e/USD)
budget-spentCurrent budget spend amount
budget-remainingRemaining budget amount
budget-percent-usedPercentage of budget used
budget-health-scoreBudget health score (0-100)
budget-forecastProjected end-of-period spend
budget-runway-daysDays until budget exhausted at current rate
budget-statusBudget health status: 'healthy' | 'warning' | 'critical' | 'exceeded'
budget-scopes-statusJSON array of scoped budget statuses from finfocus CLI