devenv-update-roadmap

Synchronize roadmap Markdown files with GitHub issue and pull request states.

Updated Jul 4, 2024
One-click install
npx skills add https://github.com/workinprogress-ai/devenv --skill devenv-update-roadmap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: devenv-update-roadmap
Source: https://github.com/workinprogress-ai/devenv/tree/main/copilot/skills/devenv-update-roadmap
Command: npx skills add https://github.com/workinprogress-ai/devenv --skill devenv-update-roadmap

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates the manual overhead of keeping project roadmaps in sync with the actual progress of development work, ensuring documentation remains a reliable source of truth.

Core Features & Use Cases

  • Automated Status Reconciliation: Maps GitHub issue and PR states to roadmap step statuses (e.g., Done, In Progress, Paused).
  • Gap Detection: Identifies roadmap steps that lack corresponding GitHub issues and facilitates their creation.
  • Use Case: When a team completes several PRs, use this skill to automatically update the roadmap document to reflect the new status of each step without manually checking every issue.

Quick Start

Use the devenv-update-roadmap skill to sync the status of the roadmap file located at docs/Roadmap/Roadmap-orders-001.md.

Frequently Asked Questions about devenv-update-roadmap

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync roadmap status with GitHub issues and PRs?

To sync roadmap status with GitHub issues and PRs, this skill parses step-specific issue references in Markdown files and computes status updates by fetching issue metadata via GitHub CLI integration. It automatically updates the roadmap document to reflect the validated state transitions of linked development work.

How do I automate updating a Markdown roadmap file based on GitHub issue states?

Automating Markdown roadmap updates involves mapping GitHub issue and PR states to roadmap step statuses, such as Done, In Progress, or Paused. This skill reconciles the roadmap document by validating state transitions and updating epic tracking bodies based on the current GitHub metadata.

Can I identify missing GitHub tracking issues for roadmap steps automatically?

Yes, you can identify missing GitHub tracking issues through gap detection. This skill parses roadmap Markdown files to identify steps that lack corresponding GitHub issues, facilitating their creation and ensuring every roadmap step has proper development tracking.

Do I need GitHub CLI integration to update project roadmap documents?

Yes, GitHub CLI integration is required to update roadmap documents. The skill relies on GitHub CLI to fetch live issue and pull request metadata, which is necessary to compute status updates and validate state transitions for the roadmap synchronization process.

What is the best way to keep project roadmaps in sync with actual development progress?

The best way to keep project roadmaps in sync with development progress is through automated status reconciliation. This eliminates manual overhead by parsing GitHub issue references within roadmap Markdown files and computing status updates based on the actual state of linked issues and PRs.

Why does my roadmap Markdown file still show outdated statuses after closing GitHub issues?

Roadmap Markdown files show outdated statuses when state transitions are not properly validated or synced. This skill computes status updates by parsing step-specific issue references and requires GitHub CLI integration to fetch current metadata and update the epic tracking bodies in the document.