Implementation:MaterializeInc Materialize CI Closed Issues Detect
| Knowledge Sources | |
|---|---|
| Domains | CI/CD, Code Quality, Issue Tracking |
| Last Updated | 2026-02-08 00:00 GMT |
Overview
The CI Closed Issues Detect tool scans the codebase for references to already-closed GitHub issues that are still used as skip conditions, TODOs, or workarounds.
Description
This module provides the ci-closed-issues-detect CI step that searches source files for GitHub issue references (e.g., materialize#1234, #1234, cloud#5678) appearing near actionable keywords like reenable, TODO, skip:, @disabled, or @pytest.mark.skip. It supports multiple GitHub repositories (MaterializeInc/materialize, MaterializeInc/cloud, MaterializeInc/database-issues, TimelyDataflow/timely-dataflow, and others). References preceded by ignore patterns like "discussion of this in" or "introduced in" are excluded. The tool uses regex-based parsing with ISSUE_RE, REFERENCE_RE, and IGNORE_RE patterns.
Usage
Use this tool in CI pipelines to detect stale issue references that should be cleaned up after the referenced issue has been closed, preventing accumulation of outdated skip conditions and workarounds.
Code Reference
Source Location
Signature
ISSUE_RE = re.compile(r"""
( TimelyDataflow/timely-dataflow\#(?P<timelydataflow>[0-9]+)
| ( materialize\# | materialize/issues/ ) (?P<materialize>[0-9]+)
| ( cloud\# | cloud/issues/ ) (?P<cloud>[0-9]+)
| ...
)
""", re.VERBOSE)
GROUP_REPO = {
"timelydataflow": "TimelyDataflow/timely-dataflow",
"materialize": "MaterializeInc/materialize",
"cloud": "MaterializeInc/cloud",
...
}
REFERENCE_RE = re.compile(r"""(reenable|TODO|skip:|@disabled|@pytest.mark.skip|...)""", re.VERBOSE | re.IGNORECASE)
IGNORE_RE = re.compile(r"""(discussion of this in|discussed in|...)""", re.VERBOSE | re.IGNORECASE)
Import
from materialize.cli.ci_closed_issues_detect import main
I/O Contract
| Input | Type | Description |
|---|---|---|
| source files | filesystem | Codebase files scanned for issue references |
| GitHub API | HTTP | Issue status checked against GitHub REST API |
| Output | Type | Description |
|---|---|---|
| report | stdout | List of closed issues still referenced in active code with file locations |
| exit code | int |
Non-zero if stale references are found |
Usage Examples
# Run closed issues detection in CI
bin/ci-closed-issues-detect