diff --git a/docs/README.skills.md b/docs/README.skills.md index f8336c61..e3fa113e 100644 --- a/docs/README.skills.md +++ b/docs/README.skills.md @@ -148,6 +148,7 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-skills) for guidelines on how to | [microsoft-skill-creator](../skills/microsoft-skill-creator/SKILL.md) | Create agent skills for Microsoft technologies using Learn MCP tools. Use when users want to create a skill that teaches agents about any Microsoft technology, library, framework, or service (Azure, .NET, M365, VS Code, Bicep, etc.). Investigates topics deeply, then generates a hybrid skill storing essential knowledge locally while enabling dynamic deeper investigation. | `references/skill-templates.md` | | [mkdocs-translations](../skills/mkdocs-translations/SKILL.md) | Generate a language translation for a mkdocs documentation stack. | None | | [model-recommendation](../skills/model-recommendation/SKILL.md) | Analyze chatmode or prompt files and recommend optimal AI models based on task complexity, required capabilities, and cost-efficiency | None | +| [msstore-cli](../skills/msstore-cli/SKILL.md) | Microsoft Store Developer CLI (msstore) for publishing Windows applications to the Microsoft Store. Use when asked to configure Store credentials, list Store apps, check submission status, publish submissions, manage package flights, set up CI/CD for Store publishing, or integrate with Partner Center. Supports Windows App SDK/WinUI, UWP, .NET MAUI, Flutter, Electron, React Native, and PWA applications. | None | | [multi-stage-dockerfile](../skills/multi-stage-dockerfile/SKILL.md) | Create optimized multi-stage Dockerfiles for any language or framework | None | | [my-issues](../skills/my-issues/SKILL.md) | List my issues in the current repository | None | | [my-pull-requests](../skills/my-pull-requests/SKILL.md) | List my pull requests in the current repository | None | diff --git a/skills/msstore-cli/SKILL.md b/skills/msstore-cli/SKILL.md new file mode 100644 index 00000000..4cd43388 --- /dev/null +++ b/skills/msstore-cli/SKILL.md @@ -0,0 +1,600 @@ +--- +name: msstore-cli +description: 'Microsoft Store Developer CLI (msstore) for publishing Windows applications to the Microsoft Store. Use when asked to configure Store credentials, list Store apps, check submission status, publish submissions, manage package flights, set up CI/CD for Store publishing, or integrate with Partner Center. Supports Windows App SDK/WinUI, UWP, .NET MAUI, Flutter, Electron, React Native, and PWA applications.' +license: MIT +--- + +# Microsoft Store Developer CLI (msstore) + +The Microsoft Store Developer CLI (`msstore`) is a cross-platform command-line interface for publishing and managing applications in the Microsoft Store. It integrates with Partner Center APIs and supports automated publishing workflows for various application types. + +## When to Use This Skill + +Use this skill when you need to: + +- Configure Store credentials for API access +- List applications in your Store account +- Check the status of a submission +- Publish submissions to the Store +- Package applications for Store submission +- Initialize projects for Store publishing +- Manage package flights (beta testing) +- Set up CI/CD pipelines for automated Store publishing +- Manage gradual rollouts of submissions +- Update submission metadata programmatically + +## Prerequisites + +- Windows 10+, macOS, or Linux +- .NET 9 Desktop Runtime (Windows) or .NET 9 Runtime (macOS/Linux) +- Partner Center account with appropriate permissions +- Azure AD app registration with Partner Center API access +- msstore CLI installed via one of these methods: + - **Microsoft Store**: [Download](https://www.microsoft.com/store/apps/9P53PC5S0PHJ) + - **WinGet**: `winget install "Microsoft Store Developer CLI"` + - **Manual**: Download from [GitHub Releases](https://aka.ms/msstoredevcli/releases) + +### Partner Center Setup + +Before using msstore, you need to create an Azure AD application with Partner Center access: + +1. Go to [Partner Center](https://partner.microsoft.com/dashboard) +2. Navigate to **Account settings** > **User management** > **Azure AD applications** +3. Create a new application and note the **Tenant ID**, **Client ID**, and **Client Secret** +4. Grant the application appropriate permissions (Manager or Developer role) + +## Core Commands Reference + +### info - Print Configuration + +Display the current credential configuration. + +```bash +msstore info +``` + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-v, --verbose` | Print verbose output | + +### reconfigure - Configure Credentials + +Configure or update Microsoft Store API credentials. + +```bash +msstore reconfigure [options] +``` + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-t, --tenantId` | Azure AD Tenant ID | +| `-s, --sellerId` | Partner Center Seller ID | +| `-c, --clientId` | Azure AD Application Client ID | +| `-cs, --clientSecret` | Client Secret for authentication | +| `-ct, --certificateThumbprint` | Certificate thumbprint (alternative to client secret) | +| `-cfp, --certificateFilePath` | Certificate file path (alternative to client secret) | +| `-cp, --certificatePassword` | Certificate password | +| `--reset` | Reset credentials without full reconfiguration | + +**Examples:** + +```bash +# Configure with client secret +msstore reconfigure --tenantId $TENANT_ID --sellerId $SELLER_ID --clientId $CLIENT_ID --clientSecret $CLIENT_SECRET + +# Configure with certificate +msstore reconfigure --tenantId $TENANT_ID --sellerId $SELLER_ID --clientId $CLIENT_ID --certificateFilePath ./cert.pfx --certificatePassword MyPassword +``` + +### settings - CLI Settings + +Change settings of the Microsoft Store Developer CLI. + +```bash +msstore settings [options] +``` + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-t, --enableTelemetry` | Enable (true) or disable (false) telemetry | + +#### Set Publisher Display Name + +```bash +msstore settings setpdn +``` + +Sets the default Publisher Display Name for the `init` command. + +### apps - Application Management + +List and retrieve application information. + +#### List Applications + +```bash +msstore apps list +``` + +Lists all applications in your Partner Center account. + +#### Get Application Details + +```bash +msstore apps get +``` + +**Arguments:** + +| Argument | Description | +| -------- | ----------- | +| `productId` | The Store product ID (e.g., 9NBLGGH4R315) | + +**Example:** + +```bash +# Get details of a specific app +msstore apps get 9NBLGGH4R315 +``` + +### submission - Submission Management + +Manage Store submissions. + +| Sub-Command | Description | +| ----------- | ----------- | +| `status` | Get submission status | +| `get` | Get submission metadata and package info | +| `getListingAssets` | Get listing assets of a submission | +| `updateMetadata` | Update submission metadata | +| `poll` | Poll submission status until complete | +| `publish` | Publish a submission | +| `delete` | Delete a submission | + +#### Get Submission Status + +```bash +msstore submission status +``` + +#### Get Submission Details + +```bash +msstore submission get +``` + +#### Update Metadata + +```bash +msstore submission updateMetadata +``` + +Where `` is a JSON string with the updated metadata. Because JSON contains characters that shells interpret (quotes, braces, etc.), you must quote and/or escape the value appropriately: + +- **Bash/Zsh**: Wrap the JSON in single quotes so the shell passes it through literally. + ```bash + msstore submission updateMetadata 9NBLGGH4R315 '{"description":"My updated app"}' + ``` +- **PowerShell**: Use single quotes (or escape double quotes inside a double-quoted string). + ```powershell + msstore submission updateMetadata 9NBLGGH4R315 '{"description":"My updated app"}' + ``` +- **cmd.exe**: Escape each inner double quote with a backslash. + ```cmd + msstore submission updateMetadata 9NBLGGH4R315 "{\"description\":\"My updated app\"}" + ``` + +> **Tip:** For complex or multi-line metadata, save the JSON to a file and pass its contents instead to avoid quoting issues: +> ```bash +> msstore submission updateMetadata 9NBLGGH4R315 "$(cat metadata.json)" +> ``` + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-s, --skipInitialPolling` | Skip initial status polling | + +#### Publish Submission + +```bash +msstore submission publish +``` + +#### Poll Submission + +```bash +msstore submission poll +``` + +Polls until the submission status is PUBLISHED or FAILED. + +#### Delete Submission + +```bash +msstore submission delete +``` + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `--no-confirm` | Skip confirmation prompt | + +### init - Initialize Project for Store + +Initialize a project for Microsoft Store publishing. Automatically detects project type and configures Store identity. + +```bash +msstore init [options] +``` + +**Arguments:** + +| Argument | Description | +| -------- | ----------- | +| `pathOrUrl` | Project directory path or PWA URL | + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-n, --publisherDisplayName` | Publisher Display Name | +| `--package` | Also package the project | +| `--publish` | Package and publish (implies --package) | +| `-f, --flightId` | Publish to a specific flight | +| `-prp, --packageRolloutPercentage` | Gradual rollout percentage (0-100) | +| `-a, --arch` | Architecture(s): x86, x64, arm64 | +| `-o, --output` | Output directory for packages | +| `-ver, --version` | Version to use when building | + +**Supported Project Types:** + +- Windows App SDK / WinUI 3 +- UWP +- .NET MAUI +- Flutter +- Electron +- React Native for Desktop +- PWA (Progressive Web Apps) + +**Examples:** + +```bash +# Initialize WinUI project +msstore init ./my-winui-app + +# Initialize PWA +msstore init https://contoso.com --output ./pwa-package + +# Initialize and publish +msstore init ./my-app --publish +``` + +### package - Package for Store + +Package an application for Microsoft Store submission. + +```bash +msstore package [options] +``` + +**Arguments:** + +| Argument | Description | +| -------- | ----------- | +| `pathOrUrl` | Project directory path or PWA URL | + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-o, --output` | Output directory for the package | +| `-a, --arch` | Architecture(s): x86, x64, arm64 | +| `-ver, --version` | Version for the package | + +**Examples:** + +```bash +# Package for default architecture +msstore package ./my-app + +# Package for multiple architectures +msstore package ./my-app --arch x64,arm64 --output ./packages + +# Package with specific version +msstore package ./my-app --version 1.2.3.0 +``` + +### publish - Publish to Store + +Publish an application to the Microsoft Store. + +```bash +msstore publish [options] +``` + +**Arguments:** + +| Argument | Description | +| -------- | ----------- | +| `pathOrUrl` | Project directory path or PWA URL | + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-i, --inputFile` | Path to existing .msix or .msixupload file | +| `-id, --appId` | Application ID (if not initialized) | +| `-nc, --noCommit` | Keep submission in draft state | +| `-f, --flightId` | Publish to a specific flight | +| `-prp, --packageRolloutPercentage` | Gradual rollout percentage (0-100) | + +**Examples:** + +```bash +# Publish project +msstore publish ./my-app + +# Publish existing package +msstore publish ./my-app --inputFile ./packages/MyApp.msixupload + +# Publish as draft +msstore publish ./my-app --noCommit + +# Publish with gradual rollout +msstore publish ./my-app --packageRolloutPercentage 10 +``` + +### flights - Package Flight Management + +Manage package flights (beta testing groups). + +| Sub-Command | Description | +| ----------- | ----------- | +| `list` | List all flights for an app | +| `get` | Get flight details | +| `delete` | Delete a flight | +| `create` | Create a new flight | +| `submission` | Manage flight submissions | + +#### List Flights + +```bash +msstore flights list +``` + +#### Get Flight Details + +```bash +msstore flights get +``` + +#### Create Flight + +```bash +msstore flights create --group-ids +``` + +**Options:** + +| Option | Description | +| ------ | ----------- | +| `-g, --group-ids` | Flight group IDs (comma-separated) | +| `-r, --rank-higher-than` | Flight ID to rank higher than | + +#### Delete Flight + +```bash +msstore flights delete +``` + +#### Flight Submissions + +```bash +# Get flight submission +msstore flights submission get + +# Publish flight submission +msstore flights submission publish + +# Check flight submission status +msstore flights submission status + +# Poll flight submission +msstore flights submission poll + +# Delete flight submission +msstore flights submission delete +``` + +#### Flight Rollout Management + +```bash +# Get rollout status +msstore flights submission rollout get + +# Update rollout percentage +msstore flights submission rollout update + +# Halt rollout +msstore flights submission rollout halt + +# Finalize rollout (100%) +msstore flights submission rollout finalize +``` + +## Common Workflows + +### Workflow 1: First-Time Store Setup + +```bash +# 1. Install the CLI +winget install "Microsoft Store Developer CLI" + +# 2. Configure credentials (get these from Partner Center) +msstore reconfigure --tenantId $TENANT_ID --sellerId $SELLER_ID --clientId $CLIENT_ID --clientSecret $CLIENT_SECRET + +# 3. Verify configuration +msstore info + +# 4. List your apps to confirm access +msstore apps list +``` + +### Workflow 2: Initialize and Publish New App + +```bash +# 1. Navigate to project +cd my-winui-app + +# 2. Initialize for Store (creates/updates app identity) +msstore init . + +# 3. Package the application +msstore package . --arch x64,arm64 + +# 4. Publish to Store +msstore publish . + +# 5. Check submission status +msstore submission status +``` + +### Workflow 3: Update Existing App + +```bash +# 1. Build your updated application +dotnet publish -c Release + +# 2. Package and publish +msstore publish ./my-app + +# Or publish from existing package +msstore publish ./my-app --inputFile ./artifacts/MyApp.msixupload +``` + +### Workflow 4: Gradual Rollout + +```bash +# 1. Publish with initial rollout percentage +msstore publish ./my-app --packageRolloutPercentage 10 + +# 2. Monitor and increase rollout +msstore submission poll + +# 3. (After validation) Finalize to 100% +# This completes via Partner Center or submission update +``` + +### Workflow 5: Beta Testing with Flights + +```bash +# 1. Create a flight group in Partner Center first +# Then create a flight +msstore flights create "Beta Testers" --group-ids "group-id-1,group-id-2" + +# 2. Publish to the flight +msstore publish ./my-app --flightId + +# 3. Check flight submission status +msstore flights submission status + +# 4. After testing, publish to production +msstore publish ./my-app +``` + +### Workflow 6: CI/CD Pipeline Integration + +```yaml +# GitHub Actions example +name: Publish to Store + +on: + release: + types: [published] + +jobs: + publish: + runs-on: windows-latest + steps: + - uses: actions/checkout@v4 + + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '9.0.x' + + - name: Install msstore CLI + run: winget install "Microsoft Store Developer CLI" --accept-package-agreements --accept-source-agreements + + - name: Configure Store credentials + run: | + msstore reconfigure --tenantId ${{ secrets.TENANT_ID }} --sellerId ${{ secrets.SELLER_ID }} --clientId ${{ secrets.CLIENT_ID }} --clientSecret ${{ secrets.CLIENT_SECRET }} + + - name: Build application + run: dotnet publish -c Release + + - name: Publish to Store + run: msstore publish ./src/MyApp +``` + +## Integration with winapp CLI + +The winapp CLI (v0.2.0+) integrates with msstore via the `winapp store` subcommand: + +```bash +# These commands are equivalent: +msstore reconfigure --tenantId xxx --clientId xxx --clientSecret xxx +winapp store reconfigure --tenantId xxx --clientId xxx --clientSecret xxx + +# List apps +msstore apps list +winapp store apps list + +# Publish +msstore publish ./my-app +winapp store publish ./my-app +``` + +Use `winapp store` when you want a unified CLI experience for both packaging and publishing. + +## Troubleshooting + +| Issue | Solution | +| ----- | -------- | +| Authentication failed | Verify credentials with `msstore info`; re-run `msstore reconfigure` | +| App not found | Ensure the product ID is correct; run `msstore apps list` to verify | +| Insufficient permissions | Check Azure AD app role in Partner Center (needs Manager or Developer) | +| Package validation failed | Ensure package meets Store requirements; check Partner Center for details | +| Submission stuck | Run `msstore submission poll ` to check status | +| Flight not found | Verify flight ID with `msstore flights list ` | +| Rollout percentage invalid | Value must be between 0 and 100 | +| Init fails for PWA | Ensure URL is publicly accessible and has valid web app manifest | + +## Environment Variables + +The CLI supports environment variables for credentials: + +| Variable | Description | +| -------- | ----------- | +| `MSSTORE_TENANT_ID` | Azure AD Tenant ID | +| `MSSTORE_SELLER_ID` | Partner Center Seller ID | +| `MSSTORE_CLIENT_ID` | Azure AD Application Client ID | +| `MSSTORE_CLIENT_SECRET` | Client Secret | + +## References + +- [Microsoft Store Developer CLI Documentation](https://learn.microsoft.com/windows/apps/publish/msstore-dev-cli/overview) +- [CLI Commands Reference](https://learn.microsoft.com/windows/apps/publish/msstore-dev-cli/commands) +- [GitHub Repository](https://github.com/microsoft/msstore-cli) +- [Partner Center API](https://learn.microsoft.com/windows/uwp/monetize/using-windows-store-services) +- [App Submission API](https://learn.microsoft.com/windows/uwp/monetize/create-and-manage-submissions-using-windows-store-services) +- [Package Flights Overview](https://learn.microsoft.com/windows/uwp/publish/package-flights) +- [Gradual Package Rollout](https://learn.microsoft.com/windows/uwp/publish/gradual-package-rollout) diff --git a/CNAME b/website/public/CNAME similarity index 100% rename from CNAME rename to website/public/CNAME diff --git a/website/src/config/learning-hub.ts b/website/src/config/learning-hub.ts index 0fbe9dc2..b68a57e3 100644 --- a/website/src/config/learning-hub.ts +++ b/website/src/config/learning-hub.ts @@ -10,6 +10,7 @@ export const fundamentalsOrder = [ 'building-custom-agents', 'understanding-mcp-servers', 'automating-with-hooks', + 'agentic-workflows', 'using-copilot-coding-agent', 'installing-and-using-plugins', 'before-after-customization-examples', diff --git a/website/src/content/learning-hub/agentic-workflows.md b/website/src/content/learning-hub/agentic-workflows.md new file mode 100644 index 00000000..ccc95a16 --- /dev/null +++ b/website/src/content/learning-hub/agentic-workflows.md @@ -0,0 +1,219 @@ +--- +title: 'Agentic Workflows' +description: 'Learn what GitHub Agentic Workflows are, how to use community workflows from Awesome Copilot, and how to contribute your own.' +authors: + - GitHub Copilot Learning Hub Team +lastUpdated: '2026-02-27' +estimatedReadingTime: '7 minutes' +tags: + - workflows + - automation + - github-actions + - fundamentals +relatedArticles: + - ./automating-with-hooks.md + - ./using-copilot-coding-agent.md +prerequisites: + - Basic understanding of GitHub Actions + - Basic understanding of GitHub Copilot +--- + +Agentic Workflows are AI-powered repository automations that run coding agents in GitHub Actions. Written in markdown with natural language instructions, they let you automate tasks like issue triage, daily reports, and compliance checks — triggered by schedules, events, or slash commands. + +This article covers what agentic workflows are, how to install and use workflows from the Awesome Copilot community, and how to contribute your own. + +## What Are Agentic Workflows? + +An agentic workflow is a markdown file that combines YAML frontmatter (triggers, permissions, safe outputs) with natural language instructions that a coding agent follows at runtime. The markdown file is the source: you use the `gh aw` CLI to compile it into a `.lock.yml` workflow file, and GitHub Actions runs that compiled workflow to execute a Copilot coding agent that follows the instructions autonomously. + +**Key characteristics**: +- Defined in a single `.md` file — no YAML actions syntax required +- Triggered by schedules, repository events, or slash commands +- Run inside GitHub Actions with the Copilot coding agent +- Use least-privilege permissions and safe outputs for security +- Compiled to `.lock.yml` files via the `gh aw` CLI + +### Anatomy of a Workflow File + +```markdown +--- +name: "Daily Issues Report" +description: "Generates a daily summary of open issues" +on: + schedule: daily on weekdays +permissions: + contents: read + issues: read +safe-outputs: + create-issue: + title-prefix: "[daily-report] " + labels: [report] +--- + +## Daily Issues Report + +Create a daily summary of open issues for the team. + +## What to Include + +- New issues opened in the last 24 hours +- Issues closed or resolved +- Stale issues that need attention +``` + +The **frontmatter** declares the workflow's triggers, permissions, and safe outputs. The **body** contains the natural language instructions the agent follows. + +### When to Use Agentic Workflows + +| Use Case | Example | +|----------|---------| +| Scheduled reports | Daily issue summaries, weekly org health checks | +| Event-driven automation | Triage new issues, check PR relevance | +| Slash commands | `/relevance-check` on an issue or PR | +| Compliance checks | License audits, release readiness reviews | +| Repository maintenance | Identify stale repos, track contributor activity | + +Agentic Workflows are ideal when you need **autonomous, event-driven automation** that goes beyond what static GitHub Actions can do — tasks that require reasoning, summarization, or context-aware decisions. + +## Using Workflows from Awesome Copilot + +The [Awesome Copilot workflows page](../../workflows/) hosts a growing collection of community-contributed workflows. Here's how to install and use them. + +### Prerequisites + +Install the `gh aw` CLI extension: + +```bash +gh extension install github/gh-aw +``` + +### Installing a Workflow + +1. **Browse** the [workflows collection](../../workflows/) and find one that fits your needs +2. **Copy** the workflow `.md` file into your repository's `.github/workflows/` directory +3. **Compile** the workflow to generate the Actions lock file: + +```bash +gh aw compile +``` + +4. **Commit** both the `.md` source and the generated `.lock.yml` file: + +```bash +git add .github/workflows/daily-issues-report.md +git add .github/workflows/daily-issues-report.lock.yml +git commit -m "Add daily issues report workflow" +``` + +### Running a Workflow + +Workflows run automatically based on their configured triggers. You can also: + +- **Trigger manually**: `gh aw run ` +- **Monitor runs**: `gh aw status` and `gh aw logs` +- **Validate locally**: `gh aw compile --validate --no-emit .md` + +### Customizing a Workflow + +Since workflows are plain markdown, customizing them is straightforward: + +- **Edit the instructions** in the body to adjust what the agent does +- **Change triggers** in the `on:` frontmatter to control when it runs +- **Adjust permissions** to match your repository's needs +- **Modify safe outputs** to control what the agent can create or update + +After editing, recompile with `gh aw compile` to regenerate the lock file. + +## Contributing Workflows + +Sharing your workflows with the community helps others automate their repositories. Here's how to contribute. + +### Step 1: Create the Workflow File + +Create a new `.md` file in the `workflows/` directory of the [Awesome Copilot repository](https://github.com/github/awesome-copilot). Use a descriptive, lowercase, hyphenated filename: + +``` +workflows/my-new-workflow.md +``` + +### Step 2: Add Frontmatter + +Include the required frontmatter fields: + +```yaml +--- +name: "My New Workflow" +description: "A clear description of what this workflow does" +on: + schedule: daily +permissions: + contents: read +safe-outputs: + create-issue: + title-prefix: "[my-workflow] " + labels: [automated] +--- +``` + +**Required fields**: +- `name` — human-readable workflow name +- `description` — concise summary of the workflow's purpose + +**Workflow fields**: +- `on` — trigger configuration (schedules, events, slash commands) +- `permissions` — GitHub API scopes (use least-privilege) +- `safe-outputs` — guardrails for what the agent can create or modify + +### Step 3: Write Clear Instructions + +The body of the file contains the natural language instructions the agent follows. Be specific and structured: + +```markdown +## Task Overview + +Describe the main goal clearly. + +## Steps + +1. First, gather the relevant data +2. Then, analyze and summarize +3. Finally, create the output (issue, comment, etc.) + +## Output Format + +Describe the expected format of the result. +``` + +### Step 4: Validate and Test + +```bash +# Validate the workflow compiles correctly +gh aw compile --validate --no-emit workflows/my-new-workflow.md +``` + +### Step 5: Submit Your Contribution + +1. Fork the repository and create a new branch +2. Add your workflow `.md` file to the `workflows/` directory +3. Run `npm run build` to update the README +4. Submit a pull request targeting the `staged` branch + +> **Important:** Only submit the `.md` source file. Do not include compiled `.lock.yml` or `.yml` files — CI will block them. + +### Workflow Contribution Guidelines + +- **Security first** — use least-privilege permissions and safe outputs instead of direct write access +- **Clear instructions** — write specific, unambiguous natural language in the workflow body +- **Descriptive names** — use lowercase filenames with hyphens (e.g., `daily-issues-report.md`) +- **Test locally** — validate with `gh aw compile --validate` before submitting +- **Document the purpose** — the `description` field should make it clear what the workflow does and when to use it + +## Learn More + +- **Official documentation**: [GitHub Agentic Workflows](https://gh.io/gh-aw) — full specification and reference +- **Browse workflows**: [Awesome Copilot Workflows](../../workflows/) — community-contributed collection +- **Contributing guide**: [CONTRIBUTING.md](https://github.com/github/awesome-copilot/blob/main/CONTRIBUTING.md#adding-agentic-workflows) — detailed contribution guidelines +- **Related**: [Automating with Hooks](../automating-with-hooks/) — deterministic automation for Copilot agent sessions +- **Related**: [Using the Copilot Coding Agent](../using-copilot-coding-agent/) — the agent that powers agentic workflows + +---