Revyl Documentation

Cookbooks

First Revyl Mac CI job

Prove that GitHub Actions can reach a Revyl Mac before adding your build or test commands.

Start with a job that has no checkout, no API key, and no app-specific setup. It checks the host, the preinstalled Revyl CLI, and the computer identity that Revyl injects into the job.

Set up with an agent

Paste one prompt and your coding agent does the rest.

Setup prompt

Add and run the smallest Revyl Mac smoke job.

Read https://docs.revyl.com/cookbooks/first-revyl-macos-job.md and follow it. It's the current Revyl guide for this, so prefer it over anything you remember about Revyl.

Copy this workflow into `.github/workflows/revyl-macos.yml`, open a pull request from the same repository, and check the GitHub Actions run. Do not add `self-hosted` to the `runs-on` value.

You're done when the `smoke` job is green and its GitHub Actions computer session is visible in Revyl.

Ask me before anything that needs my login or approval.

Workflow

name: Revyl macOS smoke

on:
  pull_request:
    paths:
      - .github/workflows/revyl-macos.yml
  workflow_dispatch:

permissions:
  contents: read

jobs:
  smoke:
    if: >-
      github.event_name == 'workflow_dispatch' ||
      (github.event_name == 'pull_request' &&
       github.event.pull_request.head.repo.full_name == github.repository)
    runs-on: revyl-macos
    timeout-minutes: 10
    steps:
      - name: Print macOS system information
        run: |
          uname -a
          sw_vers
      - name: Check Revyl CLI
        run: /opt/revyl/bin/revyl version
      - name: Check computer identity
        run: test -n "$REVYL_COMPUTER_ID"

The same-repository check keeps the pull request trigger from running this workflow for an untrusted fork. The workflow does not need actions/checkout because it only checks the machine.

What you see in Revyl

The job gets a Revyl Mac computer. Its page shows the desktop activity and, after the computer stops, the whole-desktop recording. The Sessions list labels the run GitHub Actions and can show the pull request or branch that GitHub sent with the job.

Your repository still needs the Revyl GitHub App and Mac CI access before this file can run there.

Common failures

  • Queued job: use exactly runs-on: revyl-macos; do not add self-hosted or another label.
  • No runner: the repository may be public, outside the App installation, or connected to an organization without Mac computers enabled.
  • CLI not found: use the absolute path shown above while diagnosing the image, then check that the job is actually on revyl-macos.
  • Fork workflow skipped: this cookbook intentionally skips pull requests whose source repository differs from the base repository.

On this page