Skip to content

docs: explain required versioned regex input - #108

Open
vjymisal0 wants to merge 1 commit into
github:masterfrom
vjymisal0:docs/84-explain-versioned-regex-input
Open

docs: explain required versioned regex input#108
vjymisal0 wants to merge 1 commit into
github:masterfrom
vjymisal0:docs/84-explain-versioned-regex-input

Conversation

@vjymisal0

Copy link
Copy Markdown

What changed

  • Document that enable-versioned-regex is required, has no default, and fails when omitted.
  • Explain when to use 0 versus 1, linking to the existing versioned-template example.
  • Supply the required input in the title-only workflow example.

Why

Fixes #84. Existing examples demonstrate versioning but do not explicitly explain whether the input can be omitted.

Validation

  • Parsed all five README action workflow examples and checked their versioning input.
  • Offline checks against the actual TypeScript source with real @actions/core input handling and mocked GitHub/filesystem passed: omitted input, versioning disabled, versions 1 and 2, and missing version marker.
  • node node_modules/typescript/bin/tsc --noEmit passed.
  • Production ncc bundle build passed with output redirected outside tracked files.
  • git diff --check passed.

Notes

Documentation only; no action behavior, dependencies, or generated bundle changes. The package test script is a failing placeholder and no lint script is defined. Validation harness and workflow records are local metadata, not part of this PR. No live GitHub Actions execution was performed.

Risks

Low: documents the existing required-input contract without changing it.

Copilot AI balanced review requested due to automatic review settings September 5, 2026 11:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add example of enable-versioned-regex

2 participants