Repository navigation
Four composite actions for shipping ESP32 firmware from CI, so pipelines
do not hand-roll the openssl signing and curl upload.
- uses: xanderwasserman/simpleOTA-actions@v1
with:
api-token: ${{ secrets.SIMPLEOTA_API_TOKEN }}
project-id: ${{ vars.SIMPLEOTA_PROJECT_ID }}
binary: build/my-firmware.ino.bin
version-label: ${{ steps.version.outputs.version }}
chip-family: esp32
signing-key: ${{ secrets.SIMPLEOTA_SIGNING_KEY }}
key-id: prod-2026
That signs the binary, uploads it, and starts a deployment. Omit the
signing inputs and it uploads unsigned.
The other three are for pipelines that want a person in the loop: /upload@v1signs and uploads without deploying, and outputs
artifact-id/deploy@v1creates and starts a deployment for that artifact, with
channel and group targeting and a canary strategy/promote@v1ramps, pauses, resumes, cancels or completes one
Pairuploadwithdeploybehind a GitHub Environment to gate the
rollout on an approval, thenpromoteto ramp a canary to 100%.
Notes
Required inputs are validated before anything else runs, because GitHub
does not enforcerequired: truefor composite actions. An input read
from the wrong store arrives empty, so the actions name it rather than
letting it become an opaque HTTP error. Tokens and keys belong in
Secrets, ids and hostnames in Variables.
The signing key is written to RUNNER_TEMP under umask 077 and removed by
an EXIT trap, so a failure part-way through cannot leave it behind.
Manifests are built with jq, so release notes containing quotes or
newlines cannot produce invalid JSON.
Requires bash, curl, jq and OpenSSL 3.x, all present on GitHub-hosted
Ubuntu runners. Nothing is installed at runtime.
Verified end to end against a live project: a real Arduino build signed,
uploaded and deployed through this action.
Pin to @v1 to track this major version, or @v1.0.1 for a fixed one.