This ticket proposes an enhancement to the local issue synchronization process to include more comprehensive information from GitHub issues, specifically timeline events and related commits. This will provide a richer and more complete historical context within the local Markdown issue files.
Motivation:
GitHub issue pages display a wealth of information beyond just the issue description and comments, including:
- Assignment changes (self-assigned, unassigned)
- Label additions/removals
- Parent/sub-issue relationships
- References to commits (even without a direct PR link, e.g., via commit messages containing issue IDs)
- Issue state changes (opened, closed, reopened)
Currently, our local Markdown tickets only capture a subset of this information. Integrating these timeline events and related commits will make the local tickets more self-contained and valuable for understanding the full history and context of an issue without needing to constantly refer back to GitHub.
Proposed Changes:
Extend GraphQL Queries:
- Modify the
FETCH_ISSUES_FOR_SYNC query in issueQueries.mjs to fetch timelineItems (including events like AssignedEvent, LabeledEvent, ClosedEvent, ReferencedEvent for commits/PRs) and potentially linkedPullRequests with their associated commit details.
Update #formatIssueMarkdown Method:
- Enhance the
#formatIssueMarkdown method in IssueSyncer.mjs to parse and format the newly fetched timeline events and commit information.
- Introduce new sections within the Markdown body (e.g., "Activity Log" or "Related Commits") to present this information clearly and chronologically.
This enhancement will significantly improve the utility and completeness of our local issue tracking.
This ticket proposes an enhancement to the local issue synchronization process to include more comprehensive information from GitHub issues, specifically timeline events and related commits. This will provide a richer and more complete historical context within the local Markdown issue files.
Motivation: GitHub issue pages display a wealth of information beyond just the issue description and comments, including:
Currently, our local Markdown tickets only capture a subset of this information. Integrating these timeline events and related commits will make the local tickets more self-contained and valuable for understanding the full history and context of an issue without needing to constantly refer back to GitHub.
Proposed Changes:
Extend GraphQL Queries:
FETCH_ISSUES_FOR_SYNCquery inissueQueries.mjsto fetchtimelineItems(including events likeAssignedEvent,LabeledEvent,ClosedEvent,ReferencedEventfor commits/PRs) and potentiallylinkedPullRequestswith their associated commit details.Update
#formatIssueMarkdownMethod:#formatIssueMarkdownmethod inIssueSyncer.mjsto parse and format the newly fetched timeline events and commit information.This enhancement will significantly improve the utility and completeness of our local issue tracking.