Skip to content

docs: document configurator macOS signing and WASM SITL/PWA release flow - #11963

Open
sensei-hacker wants to merge 1 commit into
iNavFlight:release/9.1from
sensei-hacker:docs-release-create-signing-wasm-pwa
Open

sensei-hacker wants to merge 1 commit into
iNavFlight:release/9.1from
sensei-hacker:docs-release-create-signing-wasm-pwa

Conversation

@sensei-hacker

Copy link
Copy Markdown
Member

What

Updates docs/development/release-create.md to reflect two post-9.1 release-process changes:

  1. Configurator macOS code signing + notarization (from inav-configurator PR iNav LED feature does not support AUX mode this is present in Betaflight #2720). The signed build is produced only by .github/workflows/release.yml, which triggers on a tag push (v*.*.* / *.*.*). This makes the configurator tag-first, so the doc now:

    • sequences SITL/WASM-SITL into the repo before tagging,
    • adds a nightly dry-run (verify the nightly macOS artifact with codesign --verify / xcrun stapler validate) so a tag isn't pushed blind,
    • documents fallbacks (workflow_dispatch, or a throwaway -sign-test tag) if the nightly doesn't fire, and
    • warns that signed artifacts must not be modified after the release build.
  2. WASM SITL + browser PWA build for 10.x+ (configurator PR FuriousFPV FortiniF4 initial support #2729), in addition to the native per-platform SITL binaries.

Firmware remains verify-before-tag; only the configurator is tag-first.

Test plan

Doc-only change. Rendered markdown reviewed; no code/build impact.

Adds the macOS code-signing/notarization sequencing (release.yml tag-push trigger + nightly dry-run before tagging), the WASM SITL + PWA build steps for 10.x+, and updates the order of operations/checklist so the configurator is tag-first while firmware stays verify-before-tag.
@qodo-code-review

Copy link
Copy Markdown
Contributor

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can enable the Remediation agent and Qodo fixes findings in a dedicated fix PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document macOS signing and WASM/PWA release sequencing

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Documents nightly validation before tag-triggered macOS signing and notarization.
• Adds WASM SITL and browser PWA release steps for 10.x+.
• Clarifies configurator tag-first sequencing while firmware remains verify-before-tag.
Diagram

graph TD
  A["Firmware CI"] --> B["SITL and WASM"] --> C["Configurator merge"] --> D["Nightly signing"] --> E{"Checks pass?"}
  E -->|Yes| F["Configurator tag"] --> G["Signed artifacts"] --> H["Draft releases"]
  E -->|No| C
Loading
High-Level Assessment

The documented approach fits the existing tag-triggered signing constraint. A nightly signing dry-run minimizes immutable-tag risk, while workflow dispatch and disposable test tags provide appropriate fallbacks without changing the release architecture.

Files changed (1) +57 / -23

Documentation (1) +57 / -23
release-create.mdDocument signed configurator and WASM/PWA release flow +57/-23

Document signed configurator and WASM/PWA release flow

• Reorders the release procedure so native and WASM SITL assets are merged before configurator tagging. Documents nightly macOS signing validation, tag-triggered notarized builds, fallback triggers, immutable signed artifacts, PWA packaging, and the distinction between configurator tag-first and firmware verify-before-tag workflows.

docs/development/release-create.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant