Spaces:
No application file
No application file
| title: "GitHub Actions & CI/CD Document Generation API" | |
| emoji: "🤖" | |
| colorFrom: blue | |
| colorTo: indigo | |
| sdk: gradio | |
| sdk_version: "4.44.0" | |
| app_file: app.py | |
| pinned: false | |
| license: mit | |
| # GitHub Actions & CI/CD Document Generation API | |
| Stop manually documenting your GitHub Actions workflows — let your pipelines write their own docs. | |
| This API automatically generates comprehensive, readable documentation from your CI/CD configuration files. It eliminates the pain of outdated READMEs and forgotten step descriptions, ensuring your team always has accurate, up-to-date docs. With a simple REST API call, you can transform any workflow YAML into professional Markdown or HTML. | |
| ## What's Included | |
| - Auto-detect all workflow steps, triggers, and environment variables from your .github/workflows files | |
| - Generate documentation in Markdown or HTML format, customizable with your own templates | |
| - Webhook integration: triggers auto-generation on every workflow push to keep docs current | |
| - Multi-repo support: manage documentation for all your GitHub repositories from a single API key | |
| - RESTful endpoints for on-demand generation, listing, and retrieval of document versions | |
| ## Who Is This For | |
| - DevOps engineers tired of manually updating CI/CD documentation | |
| - Open-source maintainers who need clear workflow docs for contributors | |
| - Teams with complex multi-step pipelines that are hard to describe in READMEs | |
| - Documentation writers who want to automate the tedious parts of their job | |
| ## How It Works | |
| Install our GitHub App in your repository, then call the API endpoint with your workflow filename. The API scans the YAML, extracts steps, triggers, secrets, and outputs, and returns a formatted document. You can also set up webhooks to auto-regenerate docs whenever you push changes to your workflows. | |
| ## Frequently Asked Questions | |
| **Does this API require a GitHub token?** | |
| Yes, for private repositories you'll need a GitHub personal access token with repo scope. Public repos work with just an API key from us. | |
| **Can I customize the output format?** | |
| Absolutely. You can supply a custom template (Jinja2 or Mustache) when calling the API. Otherwise, we provide a clean, professional default. | |
| **How often can I regenerate docs?** | |
| No limits on requests. However, to avoid rate limits, we recommend using webhook triggers so docs update only when workflows change. | |
| **Does it support reusable workflows and composite actions?** | |
| Yes. The API recursively expands reusable workflows and composite actions to produce a single, coherent document. | |
| **Is there a free tier or trial?** | |
| This is a one-time purchase for the API key. No recurring fees. You get full access to all endpoints with no usage caps. | |
| ## What You Get | |
| - Instant digital download | |
| - Complete REST API with full documentation | |
| - Free updates for life — pay once, own forever | |
| - Setup guide and usage instructions | |
| **Automate your docs now — get the API key instantly and never write a workflow README again.** | |
| ## Get the Full Version | |
| - **Demo**: Free on Hugging Face Spaces | |
| - **[Buy on Gumroad](https://homebasedigital.gumroad.com/l/brokyb)** — Instant download | |
| - **[Buy Now](https://buy.stripe.com/eVq5kDfXx9Mwg887jCcZc0F)** — Secure checkout | |
| --- | |
| *Built with [FORGE-X](https://github.com/WealthFromAI)* | |