Allow specifiying custom skip label instead of hard-coded 'no-issue' #682
Conversation
|
No linked issues found. Please add the corresponding issues in the pull request description. |
There was a problem hiding this comment.
Pull Request Overview
This PR enables users to specify a custom skip label for linked issues checks instead of using the hard-coded "no-issue" label, while still defaulting to "no-issue" for backwards compatibility. Key changes include updating the util function to read a custom label from the action input, adjusting tests and mocks to reflect the new configuration, and modifying the action and README documentation accordingly.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/util.js | Updated skip label check to use an input value but contains a variable naming shadow issue and possible input key mismatch. |
| src/action.test.js | Updated test descriptions and mocks to align with the new custom skip label behavior. |
| action.yml | Added a new input for the custom skip label, though its name may be inconsistent with util.js. |
| mocks/@actions/github.js | Modified label assignment to use the new custom skip label from the context. |
| README.md | Updated documentation to reflect the new skip label input and its behavior. |
Comments suppressed due to low confidence (1)
src/util.js:152
- The variable 'skipLinkedIssuesCheck' shadows the function name. Consider renaming it to 'skipLinkedIssuesCheckLabel' for clarity and to avoid potential confusion.
const skipLinkedIssuesCheck = core.getInput("skip-linked-issues-check-label");
| @@ -31,12 +31,18 @@ inputs: | |||
| description: "A boolean value that allow PR to link issues on any branch" | |||
| required: false | |||
| default: "false" | |||
| skip-linked-issued-check-label: | |||
There was a problem hiding this comment.
The input name in action.yml ('skip-linked-issued-check-label') does not match the key used in src/util.js ('skip-linked-issues-check-label'). Please standardize the naming across all files.
| skip-linked-issued-check-label: | |
| skip-linked-issues-check-label: |
Copilot uses AI. Check for mistakes.
Will still default to 'no-issue' for backwards compatibility.