Suggested test: copilot/dispatch-workflow-ref-override

Open Beginner friendly
#10,528 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Quiet
Tech stack
github-actions
Domain
ci-cd, testing

Research direction

Start with the existing test-copilot-dispatch-workflow.md and the test-copilot-dispatch-worker target workflow, then create test-copilot-dispatch-workflow-ref-override.md with the specified workflow_dispatch, copilot, and dispatch-workflow configuration. Done means the dispatched worker run shows the explicit payload ref rather than the triggering ref, with no new fixtures or secrets required.

Written by the indexing model from the issue text.

Description

suggested new test

Motivation

github/gh-aw#49408 — dispatch_workflow safe output now accepts a per-call ref field on the payload (DispatchWorkflowOutput.ref), which takes highest priority over configured target-ref, GITHUB_HEAD_REF, and context.ref. Branch names are normalized to refs/heads/<name>; full refs are passed through as-is.

Proposed test

  • Workflow file: test-copilot-dispatch-workflow-ref-override.md
  • Trigger: workflow_dispatch
  • Engine: copilot
  • Safe output: dispatch-workflow
  • Variant: standard

Minimal test prompt sketch

Similar to existing test-copilot-dispatch-workflow.md, but the sample/prompt sets an explicit ref (e.g. "main" or a test branch name) on the dispatch payload instead of relying on default ref resolution. Assertion: the dispatched worker run shows the overridden ref was used rather than the triggering ref.

New fixtures or secrets needed

None — reuses test-copilot-dispatch-worker as the target workflow, same as the existing dispatch-workflow test.

Notes

Existing test-copilot-dispatch-workflow.md only exercises default ref resolution (dispatches from current context, no explicit ref in payload). This new test exercises the new per-call override specifically. No open suggestion or failing test currently covers this.

Generated by 🔍 Suggest New E2E Tests · auto · 30.2 AIC · ⌖ 8.86 AIC · ⊞ 8.3K ·

Dominant language
Shell
Stars
8
Forks
5
Avg merge
18h 32m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from githubnext/gh-aw-test

All issues in githubnext/gh-aw-test

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.