Skip to content

Commit 2b925e4

Browse files
mrjfCopilot
andcommitted
Fix review comments: replace all non-ASCII with ASCII equivalents
- Replace emojis with ASCII bracket notation ([+], [x], [!], [*], etc.) - Replace em/en dashes with -- / - - Replace arrows with -> / <- - Replace box-drawing chars with ASCII art - Replace section sign with # - Add missing setup-cli lock entry in actions-lock.json - Recompile crane.lock.yml Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent ee239b0 commit 2b925e4

7 files changed

Lines changed: 182 additions & 177 deletions

File tree

.github/ISSUE_TEMPLATE/crane-migration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ metric_direction: higher
2828
- **Language**: REPLACE (e.g. Python 3.11)
2929
- **Runtime**: REPLACE (e.g. CPython)
3030
- **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
3333

3434
## Target
3535

@@ -38,28 +38,28 @@ metric_direction: higher
3838
- **Languages**: REPLACE (e.g. TypeScript, Go)
3939
- **Runtime**: REPLACE (e.g. Node 22 / Bun 1.x)
4040
- **Paths**:
41-
- `REPLACE/path/to/target` (what should live here)
41+
- `REPLACE/path/to/target` -- (what should live here)
4242
- **Bridge** *(if polyglot)*: REPLACE (e.g. "Go core compiled to WASM, called from TypeScript through a thin wrapper")
4343

4444
## Strategy
4545

4646
<!-- Choose one and justify, or leave as `auto` in the frontmatter and let Crane decide on its first iteration. -->
4747

48-
REPLACE explain why this strategy fits.
48+
REPLACE -- explain why this strategy fits.
4949

5050
- `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.
5151
- `greenfield`: target built in parallel; cutover after parity is total. Best for small, self-contained sources.
5252
- `auto`: let Crane pick on first iteration.
5353

5454
## Verification
5555

56-
<!-- A command that prints JSON containing `migration_score` (0.01.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 -->
5757

5858
```bash
5959
REPLACE_WITH_YOUR_VERIFICATION_COMMAND
6060
```
6161

62-
The metric is `migration_score` (0.01.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`.
6363

6464
## Out of scope
6565

.github/agents/agentic-workflows.agent.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ This is a **dispatcher agent** that routes your request to the appropriate speci
1515
- **Updating existing workflows**: Routes to `update` prompt
1616
- **Debugging workflows**: Routes to `debug` prompt
1717
- **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
1919
- **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
2626

2727
> [!IMPORTANT]
2828
> 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:
9797
- "Apply breaking changes from the new release"
9898

9999
### 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
101101

102102
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/report.md
103103

@@ -127,7 +127,7 @@ When you interact with this agent, it will:
127127
- "Update @playwright/test to fix the Dependabot PR"
128128

129129
### 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.
131131

132132
**Prompt file**: https://github.com/github/gh-aw/blob/v0.74.4/.github/aw/test-coverage.md
133133

@@ -154,7 +154,7 @@ When you interact with this agent, it will:
154154
**Use cases**:
155155
- "How do I trigger workflow X on the main branch?"
156156
- "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?"
158158
- "Show me all available gh aw commands"
159159

160160
### Token Consumption Optimization
@@ -164,7 +164,7 @@ When you interact with this agent, it will:
164164

165165
**Use cases**:
166166
- "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?"
168168
- "How do I compare token usage between two runs?"
169169
- "Should I use gh-proxy or the MCP server?"
170170
- "How do I use sub-agents to reduce costs?"
@@ -232,5 +232,5 @@ gh aw compile --validate
232232
- Follow security best practices: minimal permissions, explicit network access, no template injection
233233
- **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.
234234
- **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.
236236
- **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

.github/aw/actions-lock.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@
3535
"version": "v0.74.4",
3636
"sha": "d3abfe96a194bce3a523ed2093ddedd5704cdf62"
3737
},
38+
"github/gh-aw-actions/setup-cli@v0.74.4": {
39+
"repo": "github/gh-aw-actions/setup-cli",
40+
"version": "v0.74.4",
41+
"sha": "d3abfe96a194bce3a523ed2093ddedd5704cdf62"
42+
},
3843
"github/gh-aw/actions/setup@v0.50.6": {
3944
"repo": "github/gh-aw/actions/setup",
4045
"version": "v0.50.6",

.github/workflows/crane.lock.yml

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)