diff --git a/docs/src/content/docs/agent-factory-status.mdx b/docs/src/content/docs/agent-factory-status.mdx index 737c5d5c234..8808ec768d9 100644 --- a/docs/src/content/docs/agent-factory-status.mdx +++ b/docs/src/content/docs/agent-factory-status.mdx @@ -68,6 +68,7 @@ These are experimental agentic workflows used by the GitHub Next team to learn, | [DeepReport - Intelligence Gathering Agent](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/deep-report.md) | codex | [![DeepReport - Intelligence Gathering Agent](https://github.com/githubnext/gh-aw/actions/workflows/deep-report.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/deep-report.lock.yml) | `0 15 * * 1-5` | - | | [Delight](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/delight.md) | copilot | [![Delight](https://github.com/githubnext/gh-aw/actions/workflows/delight.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/delight.lock.yml) | - | - | | [Dependabot Bundler](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/dependabot-bundler.md) | copilot | [![Dependabot Bundler](https://github.com/githubnext/gh-aw/actions/workflows/dependabot-bundler.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/dependabot-bundler.lock.yml) | - | - | +| [Dependabot Burner Campaign](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/dependabot-burner.md) | copilot | [![Dependabot Burner Campaign](https://github.com/githubnext/gh-aw/actions/workflows/dependabot-burner.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/dependabot-burner.lock.yml) | - | - | | [Dependabot Dependency Checker](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/dependabot-go-checker.md) | copilot | [![Dependabot Dependency Checker](https://github.com/githubnext/gh-aw/actions/workflows/dependabot-go-checker.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/dependabot-go-checker.lock.yml) | `0 9 * * 1,3,5` | - | | [Dev](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/dev.md) | copilot | [![Dev](https://github.com/githubnext/gh-aw/actions/workflows/dev.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/dev.lock.yml) | - | - | | [Dev Hawk](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/dev-hawk.md) | copilot | [![Dev Hawk](https://github.com/githubnext/gh-aw/actions/workflows/dev-hawk.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/dev-hawk.lock.yml) | - | - | diff --git a/docs/src/content/docs/setup/quick-start.md b/docs/src/content/docs/setup/quick-start.md index 56b57e97f84..d5c7b697e44 100644 --- a/docs/src/content/docs/setup/quick-start.md +++ b/docs/src/content/docs/setup/quick-start.md @@ -5,23 +5,36 @@ sidebar: order: 1 --- -## Adding an Automated Daily Status Workflow to Your Repo +## Prerequisites -In this guide you will add the automated [**Daily Repo Status Report**](https://github.com/githubnext/agentics/blob/main/workflows/daily-repo-status.md?plain=1) to an existing GitHub repository where you are a maintainer, running in GitHub Actions. +Before you begin, ensure you have: -Remember the aim here is _automated AI_: to install something that will run _automatically_ every day, in the context of your repository, and create a fresh status report issue in your repository without any further manual intervention. If you're familiar with GitHub Actions, you will be aware of the power of automation. +- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or a [Anthropic Claude](https://www.anthropic.com/) or [OpenAI Codex](https://openai.com/api/) API key +- ✅ **GitHub Repository** - Maintainer access required +- ✅ **GitHub Actions** - Enabled in your repository +- ✅ **GitHub CLI** (`gh`) - [Install here](https://cli.github.com) v2.0.0+ +- ✅ **Operating System**: Linux, macOS, or Windows with WSL -There are hundreds of other ways to use GitHub Agentic Workflows, which you can explore in [Peli's Agent Factory](https://githubnext.github.io/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/). This workflow is just the start of what's possible. +**Time to complete**: ~5 minutes -## Prerequisites +## What You'll Build -Before installing, ensure you have: +In this guide you'll add an automated [**Daily Repo Status Report**](https://github.com/githubnext/agentics/blob/main/workflows/daily-repo-status.md?plain=1) that runs automatically every day. -- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or a [Anthropic Claude](https://www.anthropic.com/) or [OpenAI Codex](https://openai.com/api/) API key -- ✅ **GitHub Repository** - a GitHub repository you are maintainer on -- ✅ **GitHub Actions** enabled in your repository -- ✅ **GitHub CLI** (`gh`) - A command-line tool for GitHub. [Install here](https://cli.github.com) v2.0.0+ -- ✅ **Operating System**: Linux, macOS, or Windows with WSL +
+About This Workflow + +Remember the aim here is _automated AI_: to install something that will run _automatically_ every day, in the context of your repository, and create a fresh status report issue in your repository without any further manual intervention. If you're familiar with GitHub Actions, you will be aware of the power of automation. + +The Daily Repo Status Report analyzes: +- Recent repository activity (issues, PRs, discussions, releases, code changes) +- Progress tracking, goal reminders and highlights +- Project status and recommendations +- Actionable next steps for maintainers + +There are hundreds of other ways to use GitHub Agentic Workflows, which you can explore in [Peli's Agent Factory](https://githubnext.github.io/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/). This workflow is just the start of what's possible. + +
### Step 1 — Install the extension @@ -55,12 +68,10 @@ This will take you through an interactive process to: > [!TIP] > Don't have a Copilot subscription? No problem! Claude and Codex work just as well for most workflows. Just select your preferred engine when prompted and follow the setup instructions for your API key. -Once your initial run is complete, a new issue will be created in your repository with a "repo status report". The report will be automatically generated by the AI based on recent activity in your repository, including issues, PRs, discussions, releases, and code changes. It will analyze: +Once your initial run is complete, a new issue will be created in your repository with a "repo status report". The report will be automatically generated by the AI based on recent activity in your repository. -- Recent repository activity (issues, PRs, discussions, releases, code changes) -- Progress tracking, goal reminders and highlights -- Project status and recommendations -- Actionable next steps for maintainers +
+Customization Options ### Going further — Customize your workflow @@ -92,6 +103,8 @@ Some ideas for customization: Alternatively, you can browse some of the sample workflows in [Peli's Agent Factory](https://githubnext.github.io/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/) and add them to your repository using `gh aw add `, or remix them to create your own workflows. +
+ ## What's next? With that, you are up and running with your first automated agentic workflow!