Repository navigation
Releases
v1.1.0: Signed builds are made strict-ready
Signed builds from the release action and upload are now also made
strict-ready, ready for devices running a client release with strict mode
(API 1.2). No released client supports strict mode yet, so nothing changes on
your devices today. Devices in signed mode take the build as before.
What happens in a signed job
After the upload, the action runs the
SimpleOTA CLI on the runner. It
signs the build number SimpleOTA assigned, together with the project, the key
and the image's SHA-256, and attaches that strict signature to the build. The
key is used on the runner and only the signature is sent to SimpleOTA.
The step summary shows the result: signed, strict-ready or
signed, not strict-ready.
Best effort
Making a build strict-ready never fails the job. If it does not work, for
example because the CLI cannot be downloaded or the server has no
strict-signature endpoint, the upload and any deployment go ahead and the job
succeeds with a warning in this form:
::warning::<reason> Build <build> was uploaded but is not strict-ready. Finish with: simpleota build make-strict <build> <bin>
<reason> says what went wrong, for example Could not install the SimpleOTA CLI. or The strict signature was not attached.
Until a build is made strict-ready, SimpleOTA does not offer it to devices in
strict mode.
The pinned CLI
This release pins
SimpleOTA CLI 0.2.0
and the SHA-256 of its Linux and macOS archives (amd64 and arm64) in
scripts/cli-pin.txt. Signed jobs download it into RUNNER_TEMP and refuse it
if the checksum differs, so pinning the action pins the code that handles your
key. The download runs without your token or key in its environment.
- A
simpleotaalready on the runner's PATH is used instead of downloading. - The new
cli-versioninput, on the release action andupload, names
another CLI release. That release is checked only against its own published
checksums, not ones pinned here.
Unsigned builds install nothing.
Also changed
- The step summary prints the rollout percentage as a number, so
rollout-percentage: 050reads50%. - The README and links point at
wassie-devinstead ofxanderwasserman.
Upgrading
No workflow change is needed, and no existing input or output changed.
deploy and promote are unchanged. v1 points here. Pin @v1.1.0 if you
pin exactly.
Full Changelog: v1.0.3...v1.1.0
v1.0.3: API errors now say what went wrong
Failed API calls reported a bare curl exit code and threw away the server's
explanation, which was the one thing you needed.
Before
curl: (22) The requested URL returned error: 400
After
::error::SimpleOTA API returned HTTP 400: cannot pause deployment in state 'draft'
Every request used curl --fail-with-body inside a command substitution under
set -e. On an HTTP error curl writes the body to stdout and exits non-zero,
so the step died before anything read what it had just captured. Requests now
go through a small helper that keeps the status and the body apart, and fails
the step with the detail message. Transport failures are reported separately
from HTTP failures.
Applies to all four actions. Schema validation errors (422) are handled too,
where detail is a list rather than a string.
CI now exercises all four actions against a live project, rather than upload
alone as before.
Upgrading
No input or output changed, so this is a tag move. v1 points here. Pin
@v1.0.3 if you pin exactly.
Full Changelog: v1.0.2...v1.0.3
Release v1.0.2: fixes deploy and promote
Patch release. If you use deploy or promote, you want this one.
Both actions posted deployment transitions to /api/v1/projects/{id}/deployments/{id}/actions/. That path is no longer available and has been updated to /transition/.
The root simpleOTA-actions@v1 action was not affected. It uses /release/, which uploads, creates and starts in a single call, so it was never routed through the transition path.
Full Changelog: v1.0.1...v1.0.2
First Release v1.0.1
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.