codmughees/envradar

Detect undocumented, unused, and drifting environment variables in a repository.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Apr 7, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: codmughees/envradar@3b88a5835c82178df13963cbccedf234eb90cc13 # v1

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
path	Path inside the checked-out repository to scan.	no	.
config	Optional path to envradar.yml or .envradar.yml.	no	""
report-format	Output format for logs and optional report files. One of text, markdown, or json.	no	text
report-file	Optional path, relative to the scanned directory, where a report should be written.	no	""
write-example	Optional path, relative to the scanned directory, where a generated .env.example should be written.	no	""
write-docs	Optional path, relative to the scanned directory, where markdown docs should be written.	no	""
fail-on-findings	Fail the action when missing, stale, or undocumented local variables are found.	no	false
summary	Append a markdown report to the GitHub job summary.	no	true
annotations	Emit GitHub annotations for findings.	no	true
python-version	Python version used to run envradar.	no	3.11

Outputs

name	description
scanned-files	Number of files scanned.
required-runtime-count	Number of runtime variables detected in code and compose files.
documented-count	Number of documented variables detected in example files.
strict-findings	Number of strict findings.
missing-count	Number of variables missing from documented examples.
unused-count	Number of documented variables that are no longer used.
local-only-count	Number of local-only variables not present in documented examples.
workflow-only-count	Number of variables that only appear in workflow files.
has-findings	Whether strict findings were detected.
report-path	Absolute path to a generated report file, when report-file is used.
example-path	Absolute path to a generated .env.example file, when write-example is used.
docs-path	Absolute path to a generated docs file, when write-docs is used.
config-path	Absolute path to the config file that was loaded, when present.