How to deploy with GitHub Actions

​

Before you start

• Your Intuned project is at the root of a GitHub repository.
• Your Intuned settings file (Intuned.json or Intuned.jsonc) sets projectName and workspaceId. See the Intuned.json reference.
• .intuned/ is listed in your .gitignore. The CLI writes local checkout information there, and the workflow relies on it not being committed.
• You have an Intuned API key. See how to manage API keys.

​

Set up the workflow

​

1. Add your API key to GitHub

​

2. Add the workflow file

name: Deploy to Intuned

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read

env:
  INTUNED_CLI_VERSION: 0.1.19

jobs:
  deploy:
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    concurrency:
      group: intuned-deploy
      cancel-in-progress: false
    steps:
      - uses: actions/checkout@v7
      - name: Set up Node
        uses: actions/setup-node@v7
        with:
          node-version: 24
      - name: Install Intuned CLI
        run: npm install -g "@intuned/cli@$INTUNED_CLI_VERSION"
      - name: Enable Corepack
        run: corepack enable
      - name: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Typecheck
        run: npx tsc --noEmit
      - name: Deploy
        env:
          INTUNED_API_KEY: ${{ secrets.INTUNED_API_KEY }}
        run: intuned dev deploy --non-interactive --on-conflict override

name: Deploy to Intuned

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read

env:
  INTUNED_CLI_VERSION: 0.1.19

jobs:
  deploy:
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    concurrency:
      group: intuned-deploy
      cancel-in-progress: false
    steps:
      - uses: actions/checkout@v7
      - name: Set up Node
        uses: actions/setup-node@v7
        with:
          node-version: 24
      - name: Install Intuned CLI
        run: npm install -g "@intuned/cli@$INTUNED_CLI_VERSION"
      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: "3.12"
      - name: Install uv
        run: pip install uv
      - name: Install dependencies
        run: uv sync --locked
      - name: Deploy
        env:
          INTUNED_API_KEY: ${{ secrets.INTUNED_API_KEY }}
        run: intuned dev deploy --non-interactive --on-conflict override

• Triggers: the workflow runs on every push to main, and you can run it manually from the Actions tab. The if: github.ref == 'refs/heads/main' check stops a manual run from deploying any other branch.
• concurrency: only one deploy runs at a time. If several merges land while a deploy is running, GitHub keeps only the newest waiting run, so the latest commit on main is the one that ends up deployed.
• INTUNED_CLI_VERSION: pins the CLI so a new release can’t change your pipeline unannounced. Replace 0.1.19 with the latest version on npm, and bump it deliberately.
• Install dependencies: yarn install --frozen-lockfile and uv sync --locked fail if your lockfile is out of date with package.json or pyproject.toml, so dependency problems stop the job before anything is deployed. If your TypeScript project uses npm instead of Yarn, replace the Corepack and install steps with npm ci.
• Typecheck (TypeScript): a type error fails the job before anything is deployed.
• Deploy: --non-interactive turns off prompts, and --on-conflict override makes the commit replace the project on Intuned. See How the deploy works.

​

3. Run the first deploy

​

How the deploy works

• The save replaces the project’s code. The CLI normally compares your files with the version you checked out, which it records in .intuned/checkout. That file isn’t in the repository, so the workflow has no checkout to compare against. With --on-conflict override, the save replaces the project’s code with the files in the commit, and files on Intuned that aren’t in the commit are removed.
• Ignored files aren’t uploaded. The CLI skips files matched by your .gitignore and its default exclusions, such as node_modules/, .env, and .intuned/.
• The job waits for the deployment. The Deploy step fails if the deployment fails, or if it’s still pending after 10 minutes.
• Jobs defined in code deploy with the project. Files in intuned-resources/jobs/ create, update, and delete Jobs on each deploy. Jobs created in the dashboard or through the API aren’t affected. See Jobs.
• Environment variables aren’t part of the deploy. Keep the values your APIs read at runtime on Intuned. See environment variables and secrets.

​

Troubleshooting