Currently, updating the status of an issue requires manual tracking in both GitHub issues and the Kanban board. This manual effort can lead to discrepancies, delays, and inconsistencies in issue tracking, impacting team efficiency and visibility.
Proposed Solution
Implement a GitHub Actions workflow to automatically synchronize GitHub issue labels with Kanban board phases, providing seamless, bi-directional synchronization and reducing manual intervention.
Technical Requirements
Ensure that the workflow can handle multiple status changes and concurrent updates without creating duplicate labels or incorrect Kanban movements.
The workflow should execute efficiently without overloading GitHub API limits, particularly when there are numerous simultaneous updates.
Logs should be clear, timestamped, and easily accessible for troubleshooting and audit purposes.
Issue Moved: When an issue is moved within the Kanban board, the workflow automatically updates the corresponding GitHub issue label to reflect the new status.
Status Label Changed: When a status label is changed on a GitHub issue, the workflow moves the issue to the corresponding column in the Kanban board.
Bi-directional Sync: Maintain consistent updates between the Kanban board and GitHub issue labels in both directions.
Logging: Log all synchronization actions for audit and tracking purposes.
Status Mappings:
Backlog ↔ status/backlog
Ready ↔ status/ready
In Progress ↔ status/in-progress
Review ↔ status/in-review
Done ↔ status/done
Acceptance Criteria
Bi-directional Synchronization:
Moving an issue in the Kanban board automatically updates the GitHub issue label to the appropriate status.
Changing a status label on a GitHub issue moves it to the correct column in the Kanban board.
Accurate Status Mapping:
All Kanban phases (Backlog, Ready, In Progress, Review, Done) correspond accurately with GitHub status labels (status/backlog, status/ready, etc.).
Logging:
Synchronization actions should be logged with timestamps and relevant issue details, accessible for audit purposes.
Performance and Stability:
Workflow must handle multiple changes in real-time and prevent any inconsistent state due to API limitations or synchronization conflicts.
What problem would this feature solve?
Currently, updating the status of an issue requires manual tracking in both GitHub issues and the Kanban board. This manual effort can lead to discrepancies, delays, and inconsistencies in issue tracking, impacting team efficiency and visibility.
Proposed Solution
Implement a GitHub Actions workflow to automatically synchronize GitHub issue labels with Kanban board phases, providing seamless, bi-directional synchronization and reducing manual intervention.
Technical Requirements
Implementation Approach
Workflow File Location:
.github/workflows/kanban-sync.yml
Triggers:
Actions:
Status Mappings:
status/backlog
status/ready
status/in-progress
status/in-review
status/done
Acceptance Criteria
Bi-directional Synchronization:
Accurate Status Mapping:
Backlog
,Ready
,In Progress
,Review
,Done
) correspond accurately with GitHub status labels (status/backlog
,status/ready
, etc.).Logging:
Performance and Stability: