Skip to content

package.md

Latest commit

 

History

History
110 lines (75 loc) · 4.18 KB

package.md

File metadata and controls

110 lines (75 loc) · 4.18 KB

Configure Repository as Agentic Workflows Package

This prompt guides you, a coding agent, to convert the current repository (unless the request explicitly specifies a different target repository) that contains agentic-workflows and/or shared agentic-workflows into a reusable package repository.

Your Task

Configure the repository so others can install workflows from it with gh aw add by:

  1. Standardizing package structure when needed
  2. Creating an aw.yml repository package manifest at the package root
  3. Listing all package workflows in aw.yml
  4. Generating a clear package description
  5. Updating README.md with installation instructions for consumers

Step 1: Discover Package Contents

Identify all workflow markdown files and classify them:

  • Agentic workflows (.github/workflows/*.md, excluding lock files)
  • Shared workflows (workflows/*.md)
  • Shared workflow assets used by those workflows

Also detect:

  • Multiple potential package roots (repo root, nested folders, or both)
  • Existing workflows/ folders in one or more locations
  • Repo-specific dependencies (hardcoded repo names, labels, branches, teams, secrets, file paths, or assumptions)

Step 2: Standardize Structure

If structure is inconsistent, organize it into one clear package root:

  • Keep installable shared workflows in workflows/
  • Keep repository-owned runnable workflows in .github/workflows/ only when they are intentionally repo-local
  • Avoid duplicate or conflicting copies across multiple subfolders
  • If the repo has multiple candidate package folders, choose one canonical package root and document that choice in README

Do not break existing references; update relative imports/paths when files move.

Step 3: Create aw.yml Package Manifest

Create aw.yml in the package root using the supported manifest format:

manifest-version: "1"
name: Repo Assist
description: Reusable agentic workflows for <domain/use-case>.
emoji: 🤖
files:
  - workflows/example.md
  - .github/workflows/repo-workflow.md

Requirements:

  • manifest-version: use "1" (or omit and rely on default "1")
  • name: human-readable package name
  • description: concise and relevant to the actual workflows
  • emoji: optional package emoji (string)
  • files: complete list of installable agentic/shared workflows in this repository
  • File paths must be package-root-relative and point to existing markdown workflow files under workflows/ or .github/workflows/

Do not invent custom package metadata fields.

Minimal manifest (caveman optimization)

Keep package manifest simple:

  • Use only manifest-version, name, description, optional emoji, and files
  • Keep description short
  • Put only real installable workflow markdown files in files

Documentation links:

Step 4: Dependency Cleanup for Reusability

Make workflows generic and package-ready:

  • Replace hardcoded repository-specific values with parameters, inputs, or neutral defaults
  • Identify required external services/tools and clearly declare them
  • Remove references that only work in the source repository unless explicitly required
  • Ensure workflows can be consumed from another repository without manual path rewrites

If full cleanup is too large for one PR, include a prioritized follow-up list in README.

Step 5: Update README.md for Consumers

Update the package README to include:

  1. What this package provides
  2. Prerequisites/dependencies
  3. Exact install command(s), for example:
    • gh aw add owner/repo
    • gh aw add owner/repo/path/to/package (for nested packages)
  4. How to compile/use the added workflows
  5. Any required configuration after installation

The README instructions must be clear enough that another repository can adopt the package without guesswork.

Step 6: Validate and Deliver

Before finishing:

  • Verify aw.yml exists and is valid YAML
  • Verify every listed files path exists
  • Confirm README instructions match the final package structure
  • Summarize what was standardized, what dependencies were cleaned up, and any remaining follow-up items