Announcement - 2/22/2022

This is not the official Github Actions Plugin provided by MacStadium. There is no support for this plugin.

Official Plugin

Github

orka-actions-connect

Orka-Actions-Connect will allow you to run your existing GitHub Actions workflow on a single-use macOS VM in MacStadium's Orka.

Overview

Orka-Actions-Connect relies on two Actions -- jeff-vincent/[email protected] and jeff-vincent/[email protected]. These Actions are meant to run on ubuntu-latest. They are responsible for connecting to your Orka environment via VPN, spinning up a macOS VM, and ultimately tearing it down.

The resulting macOS VM in Orka registers itself as a GitHub Actions self-hosted runner tagged specifically for the workflow it has been spun up for. At this point, any number of Jobs, structured such as job2 below, will be run on the ephemeral macOS instance. Regardless of the number of jobs run on the macOS VM, the final job must follow the structure of Job3 in the example below.

Prerequesites

• Set up an Orka Account

Configure your macOS agent image

1. Spin up an Orka VM
2. Clone this repo down to the VM.
3. Run the following:

cd orka-actions-connect/agent && ./setup.sh

4. Open the Automator App
5. Choose "Application"
6. In the following view, click "Utilities" in the leftmost menu and then double click "Run Shell Script".
7. Enter the following in the view:

/Users/admin/agent/connect.sh

8. Save the application.
9. Navigate to "System Preferences" > "Users & Groups". Select "Login Items" and then drag and drop your new application to add it to your login items for the selected user.
10. Click "Login Options" in this same view, and enable automatic login for your default user.
11. From your local machine via the Orka CLI, run:

orka image list

12. Collect the VM ID of the machine you've been working on.
13. Again from the CLI, run:

orka image save

14. Pass the ID you just collected and name the image with the suffix .img.
15. Pass this new image file name in your GitHub Actions workflow as your orkaBaseImage.

Example Workflow

on:
  push:
    branches:
      - main

jobs:
  job1:
    runs-on: ubuntu-latest          # NOTE: both orka-actions-up and orka-actions-down run on `ubuntu-latest`
    steps:
    - name: Job 1
      id: job1
      uses: jeff-vincent/[email protected]
      with:
        orkaIP: http://10.221.188.100
        orkaUser: ${{ secrets.ORKA_USER }}
        orkaPass: ${{ secrets.ORKA_PASS }}
        orkaBaseImage: gha_bigsur_v3.img             # NOTE: this `.img` file is the agent that has been defined in Orka
        githubUser: ${{ secrets.GH_USER }}           # All other Orka-related values can be found in your provided IP Plan
        githubPat: ${{ secrets.GH_PAT }}
        githubRepoName: orka-actions-up
        vpnUser: ${{ secrets.VPN_USER }}
        vpnPassword: ${{ secrets.VPN_PASSWORD }}
        vpnAddress: ${{ secrets.VPN_ADDRESS }}
        vpnServerCert: ${{ secrets.VPN_SERVER_CERT }}
    outputs:
      vm-name: ${{ steps.job1.outputs.vm-name }}
         
  job2:            # NOTE: this is where your macOS-based, GitHub Actions workflow will be executed.
    needs: job1     
    runs-on: [self-hosted, "${{ needs.job1.outputs.vm-name }}"]     # NOTE: this section of the workflow can contain any number of seperate jobs,
    steps:                                                          # but each must have this `runs-on` value.
    - name: Job 2
      id: job2
      run: |
        sw_vers
  job3:
    if: always()
    needs: [job1, job2]               # NOTE: all jobs you wish to run on the macOS instance, 
    runs-on: ubuntu-latest            # along with the `orka-actions-up` job, must be listed here.
    steps:
    - name: Job 3
      id: job3
      uses: jeff-vincent/[email protected]
      with:
        orkaIP: http://10.221.188.100
        orkaUser: ${{ secrets.ORKA_USER }}
        orkaPass: ${{ secrets.ORKA_PASS }}
        orkaBaseImage: gha_bigsur_v3.img
        githubUser: ${{ secrets.GH_USER }}
        githubPat: ${{ secrets.GH_PAT }}
        githubRepoName: orka-actions-up
        vpnUser: ${{ secrets.VPN_USER }}
        vpnPassword: ${{ secrets.VPN_PASSWORD }}
        vpnAddress: ${{ secrets.VPN_ADDRESS }}
        vpnServerCert: ${{ secrets.VPN_SERVER_CERT }}
        vmName: ${{ needs.job1.outputs.vm-name }}

job2 example output

Run sw_vers
  sw_vers
  shell: /bin/bash -e {0}
ProductName:  macOS
ProductVersion: 11.3
BuildVersion: 20E232