Skip to content

fix(test): correct gh-aw compile test workspace layout for dispatch-workflow validation #1697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tamirdresher merged 1 commit into from
Aug 13, 2026
Merged

fix(test): correct gh-aw compile test workspace layout for dispatch-workflow validation #1697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions test/gh-aw-quality.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,29 +613,49 @@ describe('gh-aw: prompt budget & planning import regression', () => {
describe('gh-aw: compiled workflow contract', () => {
const ghAwAvailable = spawnSync('gh', ['aw', '--version'], { encoding: 'utf8' }).status === 0;

// Explicit timeout: this test shells out to the real `gh aw compile` binary,
// which reliably finishes in ~2-3s in isolation but can exceed the 5s vitest
// default under full-suite parallel load/contention. Bumping this avoids
// spurious CI flakiness unrelated to the assertions themselves.
it.skipIf(!ghAwAvailable)('strict-compiles and preserves prompt/config behavior', () => {
const workspace = createTestWorkspace('gh-aw-compile-');
try {
execFileSync('git', ['init', '--quiet'], { cwd: workspace });
cpSync(WORKFLOWS_DIR, join(workspace, 'workflows'), { recursive: true });
execFileSync('gh', ['aw', 'compile', 'workflows/squad.md', '--strict'], {
// gh-aw's dispatch-workflow validation (added alongside #1682's
// safe-outputs.dispatch-workflow config) resolves its dispatch target against
// a `.github/workflows/` directory that it locates relative to the compiled
// file's path, assuming the standard `<repo-root>/.github/workflows/<file>.md`
// layout. This repo distributes the gh-aw *source* one level shallower, from a
// top-level `workflows/` directory (see docs/src/content/docs/guide/gh-aw.md),
// which downstream consumers install into their own `.github/workflows/` via
// `gh aw add owner/squad/workflows/squad-implement-worker.md@dev
// owner/squad/workflows/squad.md@dev` — landing both files side-by-side there.
// Mirror that real deployment layout in the ephemeral test workspace (instead
// of a bare `workflows/` copy) so the dispatch target `squad-implement-worker`
// resolves the same way it will for every real downstream install.
cpSync(WORKFLOWS_DIR, join(workspace, '.github', 'workflows'), { recursive: true });
execFileSync('gh', ['aw', 'compile', '.github/workflows/squad.md', '--strict'], {
cwd: workspace,
encoding: 'utf8',
stdio: 'pipe',
});

const compiled = readFileSync(join(workspace, 'workflows', 'squad.lock.yml'), 'utf8');
const compiled = readFileSync(join(workspace, '.github', 'workflows', 'squad.lock.yml'), 'utf8');
expect(compiled).toContain('"auto_close_issue":false');
expect(compiled).toContain('"data_enabled":true');
expect(compiled).toContain('"required":["origin_issue","phases","schema_version","squad_artifact"]');
expect(compiled).toContain('"enum":["research","plan","plan-accepted"');
expect(compiled).toContain('{{#runtime-import shared/planning-ontology.md}}');
expect(compiled).toContain('{{#runtime-import squad.md}}');
// gh-aw records runtime-import paths relative to the repo root (not the
// compiled file's own directory), so with the real `.github/workflows/`
// deployment layout these are prefixed accordingly — verified against an
// isolated compile outside this repo/worktree entirely.
expect(compiled).toContain('{{#runtime-import .github/workflows/shared/planning-ontology.md}}');
expect(compiled).toContain('{{#runtime-import .github/workflows/squad.md}}');
expect(compiled).not.toMatch(/<!-- squad-[\w-]+(?:-v\d+)? -->/);
} finally {
rmSync(workspace, { recursive: true, force: true });
}
});
}, 20000);
});

// ---------------------------------------------------------------------------
Expand Down