docs: explain required versioned regex input - #108
Open
vjymisal0 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
enable-versioned-regexis required, has no default, and fails when omitted.0versus1, linking to the existing versioned-template example.Why
Fixes #84. Existing examples demonstrate versioning but do not explicitly explain whether the input can be omitted.
Validation
@actions/coreinput handling and mocked GitHub/filesystem passed: omitted input, versioning disabled, versions 1 and 2, and missing version marker.node node_modules/typescript/bin/tsc --noEmitpassed.git diff --checkpassed.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.