docs(action): add missing defaults and fix itemId output description#790
Open
kranthipoturaju wants to merge 1 commit into
Open
docs(action): add missing defaults and fix itemId output description#790kranthipoturaju wants to merge 1 commit into
kranthipoturaju wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the action metadata (action.yml) to accurately reflect the action’s existing runtime behavior for optional inputs and the itemId output, improving what users see in the Actions marketplace and editor tooling.
Changes:
- Documents defaults for optional inputs:
labeleddefaults to an empty string andlabel-operatordefaults toOR. - Clarifies the
itemIdoutput description to cover both “linked project item” and “cross-owner draft issue” paths. - Expands the top-level description to use “pull requests” instead of “PRs”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Fixes three inaccuracies in
action.ymlwhere the metadata diverged from the actual implementation.Changes
labeled: addeddefault: ''— reflectscore.getInput('labeled')returning an empty string when not providedlabel-operator: addeddefault: 'OR'— reflects theelsebranch in the implementation, which applies OR semantics when the input is empty or unsetitemIdoutput: replaced vague description with one that documents both code paths: linked project item (same owner) and draft issue (cross-owner fallback)description: expanded abbreviation "PRs" → "pull requests" for consistencyMotivation
The
labeledandlabel-operatorinputs had nodefault:fields, so tooling (e.g. the Actions marketplace, editor extensions) could not surface defaults to users without reading the source. TheitemIddescription wasmisleading for the cross-owner case, where the action silently creates a draft issue rather than linking the original item.
Impact
requiredflags changedTesting
action.ymlis metadata-only. Changes verified by inspecting the diff against the implementation insrc/add-to-project.ts.