doc-update

Generate and synchronize GitHub Actions documentation from action.yml changes.

5|9|Updated Dec 20, 2024
One-click install
npx skills add https://github.com/Netcracker/qubership-workflow-hub --skill doc-update-netcracker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-update
Source: https://github.com/Netcracker/qubership-workflow-hub/tree/main/.claude/skills/doc-update
Command: npx skills add https://github.com/Netcracker/qubership-workflow-hub --skill doc-update-netcracker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps documentation in lockstep with your GitHub Actions and reusable workflows by generating and updating docs from action.yml definitions and git diffs.

Core Features & Use Cases

  • Synchronizes action and reusable workflow docs from source, ensuring inputs, outputs, and usage notes stay accurate.
  • Updates README.md and glossary in docs to reflect latest code changes, reducing drift and manual editing.
  • Supports batch doc updates triggered by PRs or diffs across multiple targets, with version pin consistency.

Quick Start

Run the skill on a branch that updates actions or workflows to refresh their docs.

Frequently Asked Questions about doc-update

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

FAQPage Schema
How do I automate documentation updates for GitHub Actions from code changes?

Automate GitHub Actions documentation by reading action.yml definitions and git diffs to generate and synchronize docs. It computes diffs from source changes and updates READMEs and catalogs while preserving usage sections and updating version pins automatically.

Can I synchronize reusable workflow docs from action.yml across multiple READMEs?

Yes, you can synchronize reusable workflow docs from action.yml across multiple README targets. It reads source definitions, computes diffs, and updates documentation files to reflect the latest inputs, outputs, and usage notes with version pin consistency.

What's the best way to keep action documentation in sync with code changes on a branch?

Keeping action documentation in sync is best handled by running the skill on a branch that updates actions or workflows. It reads action.yml and target docs, computes diffs, and updates the documentation to reduce manual editing and drift.

Does this documentation generation preserve existing usage sections in README files?

Documentation generation does preserve existing usage sections in README files. It computes diffs between action.yml definitions and target docs, updating inputs, outputs, and version pins while retaining the original usage notes and formatting.

Can I trigger batch documentation updates from PRs and git diffs?

Yes, you can trigger batch documentation updates from PRs and git diffs. It supports batch updates across multiple targets when action.yml or workflow definitions change, ensuring version pin consistency and accurate docs generation.

When do I need to update version pins in GitHub Actions documentation?

Update version pins in GitHub Actions documentation when action.yml or workflow definitions change on a branch. It detects diffs, updates the version pins, and synchronizes READMEs and catalogs to keep documentation locked to the latest code.