Add only-issue-types option to filter issues by type
#1255
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new option ("only-issue-types") to filter issues by their type as part of the stale process.
- Adds a new filter option in the issues processor options and corresponding enum.
- Integrates issue type filtering within the processor with tests and documentation updates.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/interfaces/issues-processor-options.ts | Added an optional property for filtering by issue type. |
| src/interfaces/issue.ts | Added a new property for holding the issue type. |
| src/enums/option.ts | Added the OnlyIssueTypes enum option. |
| src/classes/issues-processor.ts | Updated logic to filter issues based on allowed types and log skipped ones. |
| src/classes/issue.ts | Set issue_type based on provided issue information. |
| action.yml | Added a new input parameter for only-issue-types. |
| tests/only-issue-types.spec.ts | Added tests validating the behavior of filtering on issue types. |
| tests/functions/generate-issue.ts | Extended the generateIssue function to support issue_type. |
| README.md | Updated documentation to include details about the new option. |
Comments suppressed due to low confidence (1)
src/classes/issues-processor.ts:261
- The log message uses '$$type' which appears to be a typo or unclear wording; consider replacing it with a clearer reference such as 'issue'.
`Skipping this $$type because its type ('${ issue.issue_type }') is not in onlyIssueTypes (${allowedTypes.join(', ')})`
Co-authored-by: andig <[email protected]>
|
Hello @mahabaleshwars, I wanted to kindly ask if I could get a review on this PR :) |
|
➕ would love this added in to help filter out epics versus issues |
|
+1! |
|
what is the way forward here? |
|
@maxwxyz the merge conflict should be a problem, but this PR needs some attention from the maintainers to go forward :D |
|
@rentziass @philip-gai @TingluoHuang maybe? |
|
@Bibo-Joshi I think this change looks good. If we can get the merge conflicts fixed, we can move forward with it. |
|
@luketomlinson thanks for your reply. I've resolved the merge conflicts |
|
nice, that was quick in the end :D thanks very much! |
* Add `only-issue-types` Option to Filter Issues by Type * white-space fix in readme table Co-authored-by: andig <[email protected]> --------- Co-authored-by: andig <[email protected]>
Description:
Tries to implement a filter based on the issue type on issues as described in #1187. I tried following the suggestions in #1187 (comment). Copilot did help me, though I reviewed everything manually and made sure to follow the instructions in the contribution guide. Hopefully I didn't miss anything …
Related issue:
closes #1187
Check list: