Skip to content

[docs] docs: document secrets-in-custom-steps compiler check (dev.md v5.2)#24466

Merged
pelikhan merged 1 commit intomainfrom
docs/dev-md-v5.2-secrets-custom-steps-54006272592ed8eb
Apr 4, 2026
Merged

[docs] docs: document secrets-in-custom-steps compiler check (dev.md v5.2)#24466
pelikhan merged 1 commit intomainfrom
docs/dev-md-v5.2-secrets-custom-steps-54006272592ed8eb

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Apr 4, 2026

Adds documentation for the new compiler check introduced in PR #24450 ("Add compiler check disallowing secrets expressions in custom steps").

Changes Made

  • Added Secrets in Custom Steps Validation subsection to the Compiler Validation section of scratchpad/dev.md
  • Documents validateStepsSecrets() in pkg/workflow/strict_mode_steps_validation.go:
    • Strict mode behavior (compilation error)
    • Non-strict mode behavior (warning)
    • secrets.GITHUB_TOKEN exemption
    • Migration guidance (move secrets to a separate job)
  • Bumps scratchpad/dev.md from v5.1 to v5.2

Files Modified

  • scratchpad/dev.md — added 40 lines in the Compiler Validation section; updated version header and document history

Validation

✅ Technical tone throughout (no marketing language)
✅ Code blocks have language tags
✅ No broken links
✅ Consistent with existing subsection structure

Review Notes

  1. Verify the error message text matches the current implementation in pkg/workflow/strict_mode_steps_validation.go
  2. Confirm the secrets.GITHUB_TOKEN exemption behaviour is correctly described
  3. Check that the migration example YAML is accurate for the actual frontmatter schema

Generated by Developer Documentation Consolidator · ● 536.7K ·

  • expires on Apr 6, 2026, 11:11 AM UTC

Add Secrets in Custom Steps Validation subsection to the Compiler
Validation section of scratchpad/dev.md.

Documents the new validateStepsSecrets() check introduced in
pkg/workflow/strict_mode_steps_validation.go: behavior in strict
vs. non-strict mode, GITHUB_TOKEN exemption, and migration guidance.

Bumps dev.md to v5.2.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Apr 4, 2026
@github-actions github-actions bot mentioned this pull request Apr 4, 2026
@pelikhan pelikhan merged commit b46cf1d into main Apr 4, 2026
@pelikhan pelikhan deleted the docs/dev-md-v5.2-secrets-custom-steps-54006272592ed8eb branch April 4, 2026 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant