Trigger deployment from Github Actions

[timkelty]

There isn't (yet) a direct API to trigger a deployment externally (other than git push). This would allow you to trigger deployments directly from GIthub Actions.

Until that lands, you can still achieve this will something like this:

• Keep main (or whatever) as your default branch for production code
• Create a production branch (probably make it protected)
• In Craft Console, set your environment to "on-push" / "production"

- add a deploy workflow:

# .github/workflows/deploy.yml
name: Deploy

on:
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Test
        run: |
          echo "Running tests..."
          # Add your test commands here

      - name: Update production branch
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"

          git checkout -b production
          git push -f origin production

Now, when you push to main, the workflow will be triggered, but production will only receive a push (and thus a deployment) if the steps preceding it succeed.

[stigvanbrabant]

For me the workaround is not really feasable. I've got a monorepo structure with a backend and frontend folder. Backend gets deployed automatically by craft cloud on push to the main branch. Frontend gets deployed to Vercel using Github Actions, also on push to main.

I'm having a few issues with this:

1. Craft cloud wil get deployed even when nothing has changed inside the backend folder.
2. Frontend and backend deployment run in parallel. I'd like to have it so the frontend will only build/deploy after the backend has been deployed. This because i'd like to run codegen in the frontend deploy pipeline (so we don't need to commit generated types etc.)

What i was thinking for a workaround is to use the "npm-script" config to trigger a github action through a workflow dispatch. Do you think this is achievable like this?

Ideally we would be able to do something like this:

name: Production deployment

on:
  push:
    branches:
      - main

env:
  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}

jobs:
  deploy:
    name: Deploy 🚀
    runs-on: ubuntu-latest
    outputs:
      site-url: ${{ steps.deployment.outputs.preview-url }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Craft cloud deployment
        id: craft
        uses: craftcms/cloud-deploy
        with:
          craft-token: ${{ secrets.CRAFT_TOKEN }}
          craft-project-id: ${{ secrets.CRAFT_PROJECT_ID }}

      - name: Vercel deployment
        id: vercel
        uses: amondnet/vercel-action@v25
        with:
          vercel-args: '--prod'
          vercel-token: ${{ secrets.VERCEL_TOKEN }}
          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          scope: '...'

      - name: Vercel deployment url
        run: |
          echo ${{ steps.vercel.outputs.preview-url }}