You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/crane-migration.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,8 @@ metric_direction: higher
28
28
-**Language**: REPLACE (e.g. Python 3.11)
29
29
-**Runtime**: REPLACE (e.g. CPython)
30
30
-**Paths**:
31
-
-`REPLACE/path/to/source`— (what lives here)
32
-
-`REPLACE/path/to/source-tests`— existing test suite
31
+
-`REPLACE/path/to/source`-- (what lives here)
32
+
-`REPLACE/path/to/source-tests`-- existing test suite
33
33
34
34
## Target
35
35
@@ -38,28 +38,28 @@ metric_direction: higher
38
38
-**Languages**: REPLACE (e.g. TypeScript, Go)
39
39
-**Runtime**: REPLACE (e.g. Node 22 / Bun 1.x)
40
40
-**Paths**:
41
-
-`REPLACE/path/to/target`— (what should live here)
41
+
-`REPLACE/path/to/target`-- (what should live here)
42
42
-**Bridge***(if polyglot)*: REPLACE (e.g. "Go core compiled to WASM, called from TypeScript through a thin wrapper")
43
43
44
44
## Strategy
45
45
46
46
<!-- Choose one and justify, or leave as `auto` in the frontmatter and let Crane decide on its first iteration. -->
47
47
48
-
REPLACE — explain why this strategy fits.
48
+
REPLACE -- explain why this strategy fits.
49
49
50
50
-`in-place` (strangler-fig): system stays live throughout. Each milestone ports one unit and re-routes callers. Preferred for production code or anything with external consumers.
51
51
-`greenfield`: target built in parallel; cutover after parity is total. Best for small, self-contained sources.
52
52
-`auto`: let Crane pick on first iteration.
53
53
54
54
## Verification
55
55
56
-
<!-- A command that prints JSON containing `migration_score` (0.0–1.0). Recommended: migration_score = correctness_gate × progress -->
56
+
<!-- A command that prints JSON containing `migration_score` (0.0-1.0). Recommended: migration_score = correctness_gate x progress -->
57
57
58
58
```bash
59
59
REPLACE_WITH_YOUR_VERIFICATION_COMMAND
60
60
```
61
61
62
-
The metric is `migration_score` (0.0–1.0). **Higher is better.** Optional companion fields: `progress`, `parity_passing`, `parity_total`, `source_tests_passing`, `target_tests_passing`, `perf_ratio`.
62
+
The metric is `migration_score` (0.0-1.0). **Higher is better.** Optional companion fields: `progress`, `parity_passing`, `parity_total`, `source_tests_passing`, `target_tests_passing`, `perf_ratio`.
Copy file name to clipboardExpand all lines: .github/agents/agentic-workflows.agent.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,14 +15,14 @@ This is a **dispatcher agent** that routes your request to the appropriate speci
15
15
-**Updating existing workflows**: Routes to `update` prompt
16
16
-**Debugging workflows**: Routes to `debug` prompt
17
17
-**Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt
18
-
-**Creating report-generating workflows**: Routes to `report` prompt — consult this whenever the workflow posts status updates, audits, analyses, or any structured output as issues, discussions, or comments
18
+
-**Creating report-generating workflows**: Routes to `report` prompt -- consult this whenever the workflow posts status updates, audits, analyses, or any structured output as issues, discussions, or comments
19
19
-**Creating shared components**: Routes to `create-shared-agentic-workflow` prompt
20
-
-**Fixing Dependabot PRs**: Routes to `dependabot` prompt — use this when Dependabot opens PRs that modify generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`). Never merge those PRs directly; instead update the source `.md` files and rerun `gh aw compile --dependabot` to bundle all fixes
21
-
-**Analyzing test coverage**: Routes to `test-coverage` prompt — consult this whenever the workflow reads, analyzes, or reports on test coverage data from PRs or CI runs
22
-
-**Rendering ASCII charts in markdown**: Routes to `asciicharts` guide — consult this whenever the workflow needs compact charts that render reliably in GitHub issues, comments, or discussions
23
-
-**CLI commands and triggering workflows**: Routes to `cli-commands` guide — consult this whenever the user asks how to run, compile, debug, or manage workflows from the command line, or when they need the MCP tool equivalent of a `gh aw` command
24
-
-**Reducing token consumption / cost optimization**: Routes to `token-optimization` guide — consult this whenever the user asks how to reduce token usage, lower costs, speed up workflows, or measure the impact of prompt changes with experiments
25
-
-**Choosing workflow architectures and design patterns**: Routes to `patterns` guide — consult this whenever the user asks for strategy, architecture, operating models, or pattern selection for agentic workflows
20
+
-**Fixing Dependabot PRs**: Routes to `dependabot` prompt -- use this when Dependabot opens PRs that modify generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`). Never merge those PRs directly; instead update the source `.md` files and rerun `gh aw compile --dependabot` to bundle all fixes
21
+
-**Analyzing test coverage**: Routes to `test-coverage` prompt -- consult this whenever the workflow reads, analyzes, or reports on test coverage data from PRs or CI runs
22
+
-**Rendering ASCII charts in markdown**: Routes to `asciicharts` guide -- consult this whenever the workflow needs compact charts that render reliably in GitHub issues, comments, or discussions
23
+
-**CLI commands and triggering workflows**: Routes to `cli-commands` guide -- consult this whenever the user asks how to run, compile, debug, or manage workflows from the command line, or when they need the MCP tool equivalent of a `gh aw` command
24
+
-**Reducing token consumption / cost optimization**: Routes to `token-optimization` guide -- consult this whenever the user asks how to reduce token usage, lower costs, speed up workflows, or measure the impact of prompt changes with experiments
25
+
-**Choosing workflow architectures and design patterns**: Routes to `patterns` guide -- consult this whenever the user asks for strategy, architecture, operating models, or pattern selection for agentic workflows
26
26
27
27
> [!IMPORTANT]
28
28
> For architecture/pattern-selection requests, load `https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/patterns.md` first.
@@ -97,7 +97,7 @@ When you interact with this agent, it will:
97
97
- "Apply breaking changes from the new release"
98
98
99
99
### Create a Report-Generating Workflow
100
-
**Load when**: The workflow being created or updated produces reports — recurring status updates, audit summaries, analyses, or any structured output posted as a GitHub issue, discussion, or comment
100
+
**Load when**: The workflow being created or updated produces reports -- recurring status updates, audit summaries, analyses, or any structured output posted as a GitHub issue, discussion, or comment
@@ -127,7 +127,7 @@ When you interact with this agent, it will:
127
127
- "Update @playwright/test to fix the Dependabot PR"
128
128
129
129
### Analyze Test Coverage
130
-
**Load when**: The workflow reads, analyzes, or reports test coverage — whether triggered by a PR, a schedule, or a slash command. Always consult this prompt before designing the coverage data strategy.
130
+
**Load when**: The workflow reads, analyzes, or reports test coverage -- whether triggered by a PR, a schedule, or a slash command. Always consult this prompt before designing the coverage data strategy.
@@ -154,7 +154,7 @@ When you interact with this agent, it will:
154
154
**Use cases**:
155
155
- "How do I trigger workflow X on the main branch?"
156
156
- "What's the MCP equivalent of `gh aw logs`?"
157
-
- "I'm in Copilot Cloud — how do I compile a workflow?"
157
+
- "I'm in Copilot Cloud -- how do I compile a workflow?"
158
158
- "Show me all available gh aw commands"
159
159
160
160
### Token Consumption Optimization
@@ -164,7 +164,7 @@ When you interact with this agent, it will:
164
164
165
165
**Use cases**:
166
166
- "How do I reduce the token cost of this workflow?"
167
-
- "My workflow is too expensive — how do I optimize it?"
167
+
- "My workflow is too expensive -- how do I optimize it?"
168
168
- "How do I compare token usage between two runs?"
169
169
- "Should I use gh-proxy or the MCP server?"
170
170
- "How do I use sub-agents to reduce costs?"
@@ -232,5 +232,5 @@ gh aw compile --validate
232
232
- Follow security best practices: minimal permissions, explicit network access, no template injection
233
233
-**Network configuration**: Use ecosystem identifiers (`node`, `python`, `go`, etc.) or explicit FQDNs in `network.allowed`. Bare shorthands like `npm` or `pypi` are **not** valid. See https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.
234
234
-**Single-file output**: When creating a workflow, produce exactly **one** workflow `.md` file. Do not create separate documentation files (architecture docs, runbooks, usage guides, etc.). If documentation is needed, add a brief `## Usage` section inside the workflow file itself.
235
-
-**Triggering runs**: Always use `gh aw run <workflow-name>` to trigger a workflow on demand — not `gh workflow run <file>.lock.yml`. `gh aw run` handles workflow resolution by short name, input parsing and validation, and correct run-tracking for agentic workflows. Use `--ref <branch>` to run on a specific branch.
235
+
-**Triggering runs**: Always use `gh aw run <workflow-name>` to trigger a workflow on demand -- not `gh workflow run <file>.lock.yml`. `gh aw run` handles workflow resolution by short name, input parsing and validation, and correct run-tracking for agentic workflows. Use `--ref <branch>` to run on a specific branch.
236
236
-**CLI commands reference**: For a complete guide on all `gh aw` commands and their MCP tool equivalents (for restricted environments), see https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/cli-commands.md
0 commit comments