-
Notifications
You must be signed in to change notification settings - Fork 49
Open
Description
Problem
Currently, when PRs are merged that fix issues, the related issues remain open even though they've been resolved. This creates:
- Confusion about which issues are actually still open
- Manual overhead for maintainers to close resolved issues
- Inconsistent issue tracking across the project
Proposed Solution
Add a GitHub Actions workflow that will:
Automatic Mode (Future PRs)
- Automatically close issues when PRs are merged to main
- Detect issue references in PR titles and descriptions using keywords like:
fixes #123
closes #456
resolves #789
- Add explanatory comments to closed issues
Manual Mode (Current Cleanup)
- Allow maintainers to manually close multiple issues at once
- Useful for cleaning up issues that were already fixed but not closed
Benefits
- Reduces manual work: No need to manually close issues after PR merges
- Improves project organization: Keep issue tracker accurate and up-to-date
- Follows GitHub best practices: Using standard linking keywords
- Flexible: Works both automatically and manually as needed
Implementation
- Single workflow file:
.github/workflows/close-issues.yml
- Uses GitHub's built-in
GITHUB_TOKEN
(no additional setup required) - Follows existing project formatting standards
- Includes error handling and logging
Usage for Contributors
Contributors just need to include standard GitHub linking phrases in their PRs:
- "This PR fixes X"
- "Closes #456 and resolves Y"
- "Fix for issue Z"
No additional workflow or process changes required.
Metadata
Metadata
Assignees
Labels
No labels