feat: add GitHub Actions workflow for automatic roadmap synchronization #37
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎯 Summary
This PR implements automatic synchronization of the roadmap section in README.md with the actual state of GitHub issues across the deep-assistant organization, solving issue #11.
Fixes #11
🚀 What's New
GitHub Actions Workflow
.github/workflows/sync-roadmap.ymlSynchronization Script
.github/workflows/sync-roadmap.jsDocumentation
.github/workflows/README.md✨ Features
Automatic Checkbox Updates
[ ]for open issues[x]for closed issuesMulti-Repository Support
deep-assistant/master-plandeep-assistant/telegram-botSmart Commit Strategy
Error Handling
📋 How It Works
Detection: The script scans README.md for issue references in the format:
Fetching: For each issue reference, it fetches the current state from GitHub API
Updating: Updates the checkbox on the task line associated with each issue:
- [ ]or- [x])Committing: If any changes were made, commits and pushes to the repository
🧪 Testing
The script was tested locally and correctly identifies all 45 issue references in the current README.md roadmap section:
telegram-botrepositorymaster-planrepository📚 Usage
Automatic
The workflow runs automatically daily and on issue events. No action required.
Manual
🔧 Maintenance
To add new issues to the roadmap:
[#number](url)- [ ] **Task Name**📝 Files Changed
.github/workflows/sync-roadmap.yml- GitHub Actions workflow configuration.github/workflows/sync-roadmap.js- Node.js synchronization script.github/workflows/README.md- Workflow documentation🎓 Technical Details
Permissions Required:
contents: write- To commit changes to README.mdissues: read- To fetch issue states from GitHub APIDependencies:
fs,https)API Rate Limits:
✅ Checklist
🤖 Generated with Claude Code