You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: remove misleading documentation per review feedback
Per @bcho review feedback on PR #11:
- Remove examples/demo-tracking-lifecycle.sh (feature not working)
- Remove 'Tracking Comment Lifecycle' README section (~120 lines)
Review identified that tracking comment updates are not functioning
in production despite code existing. As @bcho noted: 'obviously the
comment in the linked issue is not being updated'.
Issue #10's tracking comment was not updated to completed status,
proving the feature doesn't work as documented.
Removing documentation and demo until feature is verified working.
Addresses:
- Review comment: 'remove this file' (demo-tracking-lifecycle.sh)
- Review comment: 'remove this section' (Tracking Comment Lifecycle)
- General review: tracking comments not being updated
Ref: PR #11 review by @bcho
Co-authored-by: Shelley <shelley@exe.dev>
Copy file name to clipboardExpand all lines: modules/gh-pm/README.md
-120Lines changed: 0 additions & 120 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -675,126 +675,6 @@ bash test/test_config.sh
675
675
676
676
Tests use a minimal test framework and mock GitHub API calls. No external dependencies required.
677
677
678
-
## Tracking Comment Lifecycle
679
-
680
-
gh-pm uses GitHub comments to track task state throughout execution. Each task gets a **tracking comment** with a unique HTML marker (`<!-- gh-pm:TASK_ID -->`) that persists across updates.
681
-
682
-
### Comment States
683
-
684
-
| State | Icon | When | Description |
685
-
|-------|------|------|-------------|
686
-
|**Analyzing**| 🔍 | Task discovered | gh-pm is analyzing the task with LLM before dispatch |
687
-
|**Dispatched**| ⏳ | Workflow started | Task has been sent to workflow handler |
688
-
|**In Progress**| ⏳ | Status update | Workflow is running (optional progress messages) |
689
-
|**Completed**| ✅ |`result.json` created | Workflow finished successfully |
690
-
|**Failed**| ❌ | Process died or error | Workflow failed or crashed |
0 commit comments