Quick Start - Move a GitHub Actions Job to 9apes

This guide moves one existing GitHub Actions job to 9apes. Start with a low-risk workflow, confirm the result, then migrate more jobs.

Step 1: Install the 9apes GitHub App

1. Sign in to 9apes.
2. It will take you to the GitHub App installation flow.
3. Select the organization on which you want to use 9apes.
4. Choose the repositories on which you want to provide access to 9apes.
5. Complete the installation and return to 9apes.

Step 2: Change one job to use 9apes

Open any workflow file and change the job’s runs-on value.

Before:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm test

After:

jobs:
  test:
    runs-on: 9apes
    steps:
      - uses: actions/checkout@v4
      - run: npm test

9apes provides different configurations of runners for different use cases. You can choose the runner that best fits your needs from Available Runners.

Step 3: Push and run the workflow

Commit the workflow change and push it to GitHub.

git add <workflow-file>
git commit -m "Run CI on 9apes"
git push

Open the workflow run in GitHub Actions. The job should be picked up by a 9apes runner.

Roll back if needed

To move the job back to GitHub-hosted runners, restore the previous runs-on value and push the workflow again.

jobs:
  test:
    runs-on: ubuntu-latest