87 lines
2.6 KiB
Markdown
87 lines
2.6 KiB
Markdown
# Docs-to-Issues Workflow Fix - Implementation Summary
|
|
|
|
**Date:** 2026-01-11
|
|
**Status:** ✅ Complete
|
|
**Related PR:** #461
|
|
**QA Report:** [qa_docs_to_issues_workflow_fix.md](../reports/qa_docs_to_issues_workflow_fix.md)
|
|
|
|
---
|
|
|
|
## Problem
|
|
|
|
The `docs-to-issues.yml` workflow was preventing CI status checks from appearing on PRs, blocking the merge process.
|
|
|
|
**Root Cause:** Workflow used `[skip ci]` in commit messages to prevent infinite loops, but this also skipped ALL CI workflows for the commit, leaving PRs without required status checks.
|
|
|
|
---
|
|
|
|
## Solution
|
|
|
|
Removed `[skip ci]` flag from workflow commit message while maintaining robust infinite loop protection through existing mechanisms:
|
|
|
|
1. **Path Filter:** Workflow excludes `docs/issues/created/**` from triggering
|
|
2. **Bot Guard:** `if: github.actor != 'github-actions[bot]'` prevents bot-triggered runs
|
|
3. **File Movement:** Processed files moved OUT of trigger path
|
|
|
|
---
|
|
|
|
## Changes Made
|
|
|
|
### File Modified
|
|
|
|
`.github/workflows/docs-to-issues.yml` (Line 346)
|
|
|
|
**Before:**
|
|
```yaml
|
|
git commit -m "chore: move processed issue files to created/ [skip ci]"
|
|
```
|
|
|
|
**After:**
|
|
```yaml
|
|
git commit -m "chore: move processed issue files to created/"
|
|
# Removed [skip ci] to allow CI checks to run on PRs
|
|
# Infinite loop protection: path filter excludes docs/issues/created/** AND github.actor guard prevents bot loops
|
|
```
|
|
|
|
---
|
|
|
|
## Validation Results
|
|
|
|
- ✅ YAML syntax valid
|
|
- ✅ All pre-commit hooks passed (12/12)
|
|
- ✅ Security analysis: ZERO findings
|
|
- ✅ Regression testing: All workflow behaviors verified
|
|
- ✅ Loop protection: Path filters + bot guard confirmed working
|
|
- ✅ Documentation: Inline comments added
|
|
|
|
---
|
|
|
|
## Benefits
|
|
|
|
- ✅ CI checks now run on PRs created by workflow
|
|
- ✅ Maintains all existing loop protection
|
|
- ✅ Aligns with CI/CD best practices
|
|
- ✅ Zero security risks introduced
|
|
- ✅ Improves code quality assurance
|
|
|
|
---
|
|
|
|
## Risk Assessment
|
|
|
|
**Level:** LOW
|
|
|
|
**Justification:**
|
|
- Workflow-only change (no application code modified)
|
|
- Multiple loop protection mechanisms (path filter + bot guard)
|
|
- Enables CI validation (improves security posture)
|
|
- Minimal blast radius (only affects docs-to-issues automation)
|
|
- Easily reversible if needed
|
|
|
|
---
|
|
|
|
## References
|
|
|
|
- **Spec:** [docs/plans/archive/docs_to_issues_workflow_fix_2026-01-11.md](../plans/archive/docs_to_issues_workflow_fix_2026-01-11.md)
|
|
- **QA Report:** [docs/reports/qa_docs_to_issues_workflow_fix.md](../reports/qa_docs_to_issues_workflow_fix.md)
|
|
- **GitHub Docs:** [Skipping Workflow Runs](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs)
|