Skip to content

Document --cancel-previous #5

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

Open
finalerock44 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document --cancel-previous #5

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,30 @@ eas env:create --scope project --environment production --environment preview --

EAS automatically injects project-scoped secrets into every step as process environment variables — **don't** reference them via `${{ secrets.X }}` in YAML (that syntax isn't supported by EAS Workflows).

## Cancelling superseded runs

Every `dcd cloud` flag is forwarded verbatim, so `--cancel-previous` works
here with no wrapper support needed. It cancels the still-queued tests of the
previous run of this job on the same branch or PR:

```yaml
- run: |
npx --yes @devicecloud.dev/eas-workflow@v1 \
--app-file ${{ steps.download.outputs.artifact_path }} \
--flows ./.maestro \
--cancel-previous
```

The context comes from the `DCD_GH_*` env vars the job already sets, so
`DCD_GH_BRANCH` (or `DCD_GH_PR_NUMBER`) and `DCD_GH_REPO` must be present or
nothing is cancelled. Set `DCD_CHECK_NAME` per job when a commit runs this more
than once — it scopes the group, so without it the iOS job would cancel the
Android job's queued tests.

Only queued tests are cancelled; anything already on a device finishes and
reports normally. Cancelled tests are refunded at 75%, and the superseded run
exits 0 rather than failing your workflow.

## Documentation

Full documentation including all environment variables, CLI flags, outputs, and migration notes:
Expand Down