Codemagic

To ship every commit from Codemagic, codemagic.yaml carries two parts. Every store-build workflow imports a variable group holding HOTCODEPUSH_TOKEN, so the build step registers the store build. A workflow on every push to main releases the over-the-air (OTA) update.

Ship every commit has the prerequisites and the three disciplines. This page carries the codemagic.yaml workflows.

Secrets to setCopy Anchor Link

Both live under the app's Environment variables tab or the team's Global variables and secrets, Secret on, each in a group imported under environment.groups. Nothing goes under vars, which is committed with the file.

Two groups keep the key out of the store builds:

Codemagic does not document how it treats a pull request from a fork. In a repository that takes outside contributions, keep both groups out of every workflow on pull_request.

The pipelineCopy Anchor Link

Codemagic starts a codemagic.yaml workflow through the repository's webhook. Create webhook in the app settings adds it.

The store buildsCopy Anchor Link

Add the token's group to each existing store-build workflow, iOS and Android:

workflows:
  ios-store-build:
    environment:
      groups:
        - hotcodepush

The build step that init added runs binary create. Codemagic sets CI, so it fails without the token. The default images ship Node.js 22 or later, and a workflow pinned to xcode: 16.0 adds node: lts.

Before ./gradlew or xcode-project build-ipa:

Two quick starts need a change:

• The Expo quick start moves support-files/build.gradle over android/app/build.gradle after the prebuild, which drops the Gradle line the config plugin wrote. Copy the support file from a prebuild that ran the plugin.
• The Capacitor quick start on Swift Package Manager has no iOS workspace: xcode-project build-ipa --project ios/App/App.xcodeproj --scheme App. Its Android workflow sets java: 21.

The OTA releaseCopy Anchor Link

workflows:
  ota-release:
    name: Release to production
    instance_type: mac_mini_m2
    environment:
      groups:
        - hotcodepush
        - hotcodepush_signing
    triggering:
      events:
        - push
      branch_patterns:
        - pattern: main
          include: true
    scripts:
      - name: Install dependencies
        script: npm ci
      - name: Build the web app
        script: npm run build
      - name: Release to production
        script: npx hotcodepush release create --channel production --bundle-version "$(git rev-parse --short HEAD)" --git-ref "$CM_BRANCH" --yes --json

• A React Native or Expo app drops the npm run build step: the CLI packages the bundle per platform inside the upload. A Cordova app whose www is written by hand drops it too.
• Codemagic does not document whether the clone is on the branch, so --git-ref "$CM_BRANCH" records it. release lists every flag.

A failed command fails the step with the CLI's exit code and prints the error as JSON, and the error catalog names the fix. A green build and a device that did not take the release is the other case. See Troubleshooting.

A preview channel per pull request runs from another workflow on pull_request. Test with preview channels has the commands. Codemagic runs no workflow when a pull request closes, so give the channel an expiry.

What stays separateCopy Anchor Link

• OTA services: Codemagic's own are CodePush by Codemagic and Codemagic Patch. Each needs its own SDK in the app, so an app on HotCodePush uses neither. An app leaving Patch follows Migrate from Codemagic Patch. Codemagic runs the builds and the release line, and the update comes from HotCodePush.
• Billing: Codemagic bills its own plans, and HotCodePush bills by monthly active devices (Billing and MAU).

Next stepsCopy Anchor Link

• Ship every commit names the three disciplines a pipeline that ships every commit keeps.
• Test with preview channels builds the tester build that follows a preview channel from the QR code.
• Roll out gradually puts --rollout-percent 10 --progression on the release line and explains the counters behind auto-pause.