docs: document api-key fallback behavior#671
Conversation
Signed-off-by: Thinking-builder <15251793056@163.com>
|
I reviewed the current action.yml description for api-key:
Since #665, enabling use-policy-store without an API key no longer fails the action — it falls back to audit mode with a warning. The description should reflect that. Suggested replacement:
This covers: the fallback behavior, the warning, the audit mode default, and the fact that the key is irrelevant when use-policy-store is false. |
Summary
Update the
api-keyaction input description to document its current fallback behavior.Motivation
Since #665, enabling
use-policy-storewithout an API key no longer fails the action. Harden-Runner emits a warning and defaults to audit mode, butaction.ymlstill says the key is required.Changes
api-keyinput description.Validation
git diff --checknpm test -- --runInBand(67 tests passed)npm run build(passed; nodist/changes)action.ymlas YAML and checked the updated descriptionnpm run lintreports 80 existing errors in unchangedsrc/files