Skip to main content

​
Before you start

Start from a new workspace. Complete GitHub setup and select your repositories.

​
Start shadow mode

  1. Open Runners.
  2. Under Choose how to start, choose Shadow first.
  3. Open the Shadow CI on Peak pull request in each repository.
  4. Review it and merge it.
  5. Check that the repository shows Shadow.
Expect a shadow pull request for each repository you add later.

​
Review the shadow pull request

Check that your workflows are unchanged. Check that the pull request adds only these files.
If your CI runs actionlint, check the Peak labels added to this file.
Read each list in the pull request. To undo before merging, close the pull request and delete its branch.

​
Check which jobs are copied

Expect copies of Linux jobs that run on push and pull request events. Expect jobs on other providers’ Linux labels to run on a Peak runner of a matching size. Expect only the Linux rows of a matrix. Expect Peak to skip these jobs:
  • Windows and macOS jobs.
  • Deploy and release jobs.
  • Jobs that use an environment with protection rules.
  • Reusable workflows from other repositories.
  • Jobs whose runner comes from variables, inputs, or another job’s outputs.
  • Jobs that use a skipped job’s outputs or artifacts.
  • Workflows that run only on a schedule, by hand, or on other events.

​
Check that shadow jobs stay safe

Check these changes in each shadow workflow. Check each shadow workflow for steps that still publish or deploy. Read each shadow job’s result in its last step.

​
Read the shadow report

Open Runners. Choose Shadow report beside a repository. To see every repository, open the shadow report. Choose 7, 14, or 30 days. Open a failed job’s Peak and GitHub links to compare both runs. As a Member, choose Connect GitHub if asked.

​
Move to Peak

  1. Choose Move to Peak beside the repository on Runners or in the shadow report.
  2. Review the Run CI on Peak pull request.
  3. Merge it.
Check that each changed runner keeps its old label in a comment.
Check that the pull request deletes every shadow file. Then check the first run. To go back, choose Back to shadow beside the repository. Merge the Move CI back to shadow pull request. Check that it restores your old labels and adds the shadow copy.

​
Remove shadow mode

  1. Choose Remove shadow beside the repository.
  2. Merge the Remove Peak shadow CI pull request.
Check that it deletes only shadow files. Remove the Peak labels from your actionlint config if you no longer need them. Remove shadow mode before you remove the repository from Peak.

​
Limits

Merge or close the open Peak pull request before you choose another action. Expect longer queue times while all your repositories are in shadow mode. Keep shadow mode as long as you need. Expect no GitHub-hosted minutes for shadow jobs.