Skip to main content

Migrating from GitHub Actions

If you already use GitHub Actions, migrating your workflows to Worktree Actions is a simple process.

Update your Workflows​

There are a few differences in Action names and required setup steps for Worktree Actions.

Fully-qualify your GitHub Action names​

Action names will default to pull from Worktree instead of GitHub.

In order to keep using the versions published on GitHub, you'll need to "qualify" the action names with their full URL. For example, this step which uses the aws-actions/configure-aws-credentials action from GitHub needs to use the full GitHub URL:

jobs:
  release-image:
    runs-on: ubuntu-latest
    steps:
      - name: Configure AWS credentials
        uses: https://github.com/aws-actions/configure-aws-credentials@v4
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ env.AWS_REGION }}

Replace common actions with Worktree equivalents​

Some common actions exist on Worktree as well, under the actions organization. Currently, the following actions can be used without pulling from GitHub:

Worktree Action NameReplaces GitHub Equivalent
actions/checkoutactions/checkout
actions/setup-qemudocker/setup-qemu-action

Worktree Actions Caveats​

A few features of GitHub Actions are not supported by Worktree Actions.

  • Neither macOS nor Windows runner images are supported.
  • Build caching is currently disabled, but is on the roadmap.