diff --git a/README.md b/README.md index 6e8400f..e433dfa 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,40 @@ A wizard interface to create GitHub Agentic Workflows. Create ready-to-use [GitHub Agentic Workflows](https://github.github.com/gh-aw/) in minutes — just answer a few questions and get a workflow file you can drop into your repo. +## Customize the wizard + +The dashboard is rendered at runtime from [`src/wizard.json`](src/wizard.json). The file defines the +landing-page text, footer labels and URLs, archetype ordering, trigger/output/extra/engine cards, +summary text, recommendation mappings, and the URLs of the pattern library and engine catalog. + +To host a customized wizard in another repository: + +1. Run `npm run build` and publish the contents of `dist/`. +2. Edit the published `wizard.json` without rebuilding the JavaScript bundle. +3. Point `patterns_url` at a compatible pattern manifest. Relative URLs are resolved from the + location of `wizard.json`, so the configuration and its pattern library can be hosted together. + The `recommendations.safe_outputs` map retains singular and plural aliases where upstream pattern + libraries use both forms (for example, `add-label` and `add-labels`). + +The default page reads the configuration URL from: + +```html + +``` + +An embedding application can instead call `initWizard({ configUrl })`. Cross-origin configuration, +pattern, and engine endpoints must allow the embedding origin with CORS headers. Option IDs should +match definitions in the configured pattern library's `workflow-generation.json`. + +## Development + +```bash +npm install +npm run dev +npm test +npm run build +``` + ## License MIT diff --git a/patterns/archetypes/code-improvement.json b/patterns/archetypes/code-improvement.json index ea3c5c3..2ef7d21 100644 --- a/patterns/archetypes/code-improvement.json +++ b/patterns/archetypes/code-improvement.json @@ -56,6 +56,8 @@ "Use schedule triggers for continuous maintenance coverage", "Add pre-steps to run tests/linters before the agent starts \u2014 validates baseline", "Avoid pr-fix and ci-doctor templates \u2014 both have <20% success in practice", + "Use explicit DO NOT constraints to keep changes scoped to the requested improvement", + "Use protected-files: fallback-to-issue for manifests, CI configuration, and agent instructions", "Add a pre-activation step that skips scheduled runs once too many open PRs share your title prefix, to avoid spamming maintainers" ], "anti_patterns": [ diff --git a/patterns/archetypes/dependency-monitor.json b/patterns/archetypes/dependency-monitor.json index cbd98b5..3a495dd 100644 --- a/patterns/archetypes/dependency-monitor.json +++ b/patterns/archetypes/dependency-monitor.json @@ -57,7 +57,9 @@ "tips": [ "Use schedule triggers for reliable periodic checks", "Include a checklist of specific dependencies to monitor \u2014 don't leave it open-ended", - "Enable network access for fetching upstream release data" + "Enable network access for fetching upstream release data", + "Use DO NOT constraints to prevent unrelated dependency or source changes", + "Use skip-if-match to prevent duplicate scheduled findings" ], "anti_patterns": [ "skills-updater", diff --git a/patterns/archetypes/documentation-updater.json b/patterns/archetypes/documentation-updater.json index 93ca185..0699f38 100644 --- a/patterns/archetypes/documentation-updater.json +++ b/patterns/archetypes/documentation-updater.json @@ -56,6 +56,7 @@ "80% success rate \u2014 reliable when scoped to specific doc areas", "Add pre-steps to validate docs build before the agent starts", "Use DO NOT constraints to prevent deleting existing content", + "Use protected-files: fallback-to-issue for manifests, CI configuration, and agent instructions", "Add a pre-activation step that skips scheduled runs once too many open PRs share your title prefix, to avoid spamming maintainers" ], "anti_patterns": [ diff --git a/patterns/archetypes/status-report.json b/patterns/archetypes/status-report.json index c7c22b5..744393b 100644 --- a/patterns/archetypes/status-report.json +++ b/patterns/archetypes/status-report.json @@ -55,7 +55,8 @@ "tips": [ "Pre-fetch data in a steps: block \u2014 #1 predictor of workflow health", "Use schedule triggers for repeatable reporting", - "Keep prompts focused on one report \u2014 multi-source reports need pre-steps" + "Keep prompts focused on one report \u2014 multi-source reports need pre-steps", + "Use DO NOT constraints to prevent repository changes while generating reports" ], "anti_patterns": [ "daily-repo-status", diff --git a/src/index.html b/src/index.html index d25da6f..4a45dca 100644 --- a/src/index.html +++ b/src/index.html @@ -3,6 +3,7 @@ + GitHub Agentic Workflow Generator