Skip to content

[mac] add code-signing and notarisation#425

Open
ddol wants to merge 7 commits intomainfrom
dd/mac/dmg-signing
Open

[mac] add code-signing and notarisation#425
ddol wants to merge 7 commits intomainfrom
dd/mac/dmg-signing

Conversation

@ddol
Copy link
Copy Markdown
Member

@ddol ddol commented Mar 23, 2026

Purpose

This pull request introduces a complete, automated pipeline for codesigning, notarising, and verifying the macOS visualiser app and its DMG, both for local development and CI. It adds new Makefile targets, a robust shell script for handling all steps, workflow enhancements for CI, and comprehensive documentation for setup and troubleshooting.

Changes

Build & Release Automation:

  • Added new Makefile targets: sign-mac, notarise-mac, verify-mac, and release-mac to automate codesigning, notarisation, verification, and full release of the macOS visualiser app and DMG. These targets use a new script to handle the required steps and checks. [1] [2] [3]

  • Introduced scripts/codesign-notarise.sh, a comprehensive script that handles codesigning the app, submitting the DMG for notarisation, stapling the notarisation ticket, and verifying signatures and staples. It supports both local and CI authentication methods for notarisation.

CI/CD Integration:

  • Enhanced the GitHub Actions workflow (.github/workflows/mac-ci.yml) to automatically import the Developer ID certificate, codesign the app, notarise and staple the DMG, and verify signatures when the relevant secrets are set. This ensures that release artefacts are securely signed and notarised in CI. [1] [2]

Documentation:

  • Expanded tools/visualiser-macos/BUILDING.md with a new section detailing the codesigning and notarisation process, including one-time setup instructions, configuration variables, CI secrets, and troubleshooting for common issues.

Checklist

  • Uses British English spelling/wording where applicable.
  • Design is confirmed and aligns with DESIGN.md.
  • Any maths/derived values are valid and up to date.
  • Version has been bumped where required.
  • Documentation is up to date.
  • README.md is up to date.
  • docs/DEVLOG.md is up to date.

@ddol ddol self-assigned this Mar 23, 2026
Copilot AI review requested due to automatic review settings March 23, 2026 04:28
@github-actions
Copy link
Copy Markdown

Coverage report

This PR does not seem to contain any modification to coverable code.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an automated macOS distribution pipeline for the Visualiser, covering Developer ID codesigning, Apple notarisation/stapling, and verification for both local use (via make) and CI (GitHub Actions).

Changes:

  • Adds new Make targets to sign, notarise, verify, and run a full macOS release pipeline for the Visualiser DMG.
  • Introduces scripts/codesign-notarise.sh to encapsulate signing/notarisation/verification steps.
  • Extends the macOS CI workflow and Visualiser build docs to support (optional) signing + notarisation when secrets are present.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
tools/visualiser-macos/BUILDING.md Documents signing/notarisation setup, configuration, CI secrets, and troubleshooting.
scripts/codesign-notarise.sh New script implementing codesigning, notarisation/stapling, and verification commands.
Makefile Adds sign-mac, notarise-mac, verify-mac, release-mac targets wiring to the script.
.github/workflows/mac-ci.yml Adds steps to import signing cert, codesign, notarise/staple, and verify in CI when configured.

Comment thread .github/workflows/mac-ci.yml
Comment thread .github/workflows/mac-ci.yml
Comment thread scripts/codesign-notarise.sh Outdated
Comment thread scripts/codesign-notarise.sh Outdated
ddol added a commit that referenced this pull request Mar 23, 2026
- Add [#422] [#418] [#416] [#419] [#413] to 7 Complete items missing PR refs
- Move Go god file splitting Phase 1 ([#412] [#417]) to Complete
- Add [#421] [#425] [#391] [#390] [#392] to open items with active PRs
@ddol ddol force-pushed the dd/mac/dmg-signing branch from 59e0841 to 1cc1c3c Compare March 23, 2026 06:41
ddol added a commit that referenced this pull request Mar 23, 2026
- Add [#422] [#418] [#416] [#419] [#413] to 7 Complete items missing PR refs
- Move Go god file splitting Phase 1 ([#412] [#417]) to Complete
- Add [#421] [#425] [#391] [#390] [#392] to open items with active PRs
ddol added a commit that referenced this pull request Mar 24, 2026
- Add [#422] [#418] [#416] [#419] [#413] to 7 Complete items missing PR refs
- Move Go god file splitting Phase 1 ([#412] [#417]) to Complete
- Add [#421] [#425] [#391] [#390] [#392] to open items with active PRs
ddol added a commit that referenced this pull request Mar 24, 2026
* [docs] Refactor structural hygiene plan: update implementation status and fix JSON tag inconsistencies

* [go] Enhance error handling in radar and lidar processing: add error checks for setting ring elevations and background parameters

* [js] Refactor Event and RawRadarStats interfaces: update property names to camelCase for consistency

* [go] Fix metric key casing in cosine correction test: change "MaxSpeed" to "max_speed" for consistency

* [go] Fix casing for radar event API keys: change "magnitude", "uptime", and "speed" to "Magnitude", "Uptime", and "Speed" for consistency

* Fix casing for EventAPI keys: change "Magnitude", "Uptime", and "Speed" to "magnitude", "uptime", and "speed" for consistency

* [docs] Standardize JSON tags for EventAPI and RadarObjectsRollupRow to snake_case

* [docs][ai] backlog audit: PR refs, landed items, open PR links

- Add [#422] [#418] [#416] [#419] [#413] to 7 Complete items missing PR refs
- Move Go god file splitting Phase 1 ([#412] [#417]) to Complete
- Add [#421] [#425] [#391] [#390] [#392] to open items with active PRs

* [docs] sort completed

* [docs] sort backlog

* [docs] backlog: reorder completed items for clarity and consistency

* [docs][ai] backlog 0.5.x merge update: move #420 to Complete and add #424 in Complete

* [docs][ai] backlog PR ref audit: fix misattributed and dead PR tags

- Remove [#421] LiDAR tracks table consolidation from v0.5.0 open
  (already landed in #419, correctly in Complete section)
- Remove [#392] tag from unpopulated data remediation (PR stale/abandoned)
- Remove [#389] VRLOG frame coalescing from open (landed via #381);
  add to Complete as [#381]
- Remove [#393] SSE item; replace with untagged SSE backpressure item
  (subscriber buffer landed in #380; full backpressure outstanding)
- Remove [#382] tag from sweep workers open item (plan doc merged,
  implementation outstanding); add [#382] to Complete
- Remove [#387] duplicate from v0.6.0 (plan merged, implementation
  is #429 already in v0.5.0); add [#387] to Complete

* [ver] bump version to 0.5.0-pre25 across all relevant files

* [sh] add version-bump script and update Makefile for version management

* [docs] add backlog item for displaying runtime version and git SHA in settings UI

* [docs] update backlog item for v0.7.0 - unify frontend terminology

* [docs] compelte backlog item

* [docs] update implementation snapshot and findings in go codebase structural hygiene plan

* [docs] update Go Codebase Structural Hygiene Plan to reflect current implementation status and outstanding tasks

* [docs] add template for project planning documentation

* [docs] add binary size reduction plan to address excessive binary size

* [js][make] enhance build environment setup to include versioning information

* [docs] add clean-web target to remove build artifacts

* [docs] update binary size reduction plan and add governance document
@ddol ddol force-pushed the dd/mac/dmg-signing branch from 1cc1c3c to e05f700 Compare March 25, 2026 07:07
ddol added 6 commits March 25, 2026 00:08
- Change if: env.* to if: secrets.* so step guards evaluate correctly
- Fix CODESIGN_IDENTITY doc comment to match actual default
- Use bash array for notarytool auth flags to avoid word-splitting
- Add NOTARY_KEYCHAIN default pointing to login keychain
- Pass --keychain flag to notarytool for credential lookup
- Remove spctl --assess --type open for DMGs (unreliable for
  notarised-but-not-codesigned DMGs); keep stapler validate
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.

2 participants