Skip to content

feat(actions): reusable macOS release composites - #1

Merged
diazdesandi merged 4 commits into
mainfrom
chore/macos-release-actions
Jul 27, 2026
Merged

feat(actions): reusable macOS release composites#1
diazdesandi merged 4 commits into
mainfrom
chore/macos-release-actions

Conversation

@diazdesandi

@diazdesandi diazdesandi commented Jul 27, 2026

Copy link
Copy Markdown
Member

Summary

  • Add parameterized macOS release composite actions under actions/
  • Document org-qualified usage for repos outside thaw-app (e.g. stonerl/Thaw):
uses: thaw-app/org-ci/actions/configure-signing@bfdd9ad0c1ec61c47f1eae872909a99f16c13357
  • export-and-package links packaging art to public thaw-app/brand-assets by default

Test plan

  • Spot-check each action.yml parses
  • Consumer PR on Thaw pins this SHA and runs build-dmg / release dry path

Summary by CodeRabbit

  • New Features

    • Added reusable macOS CI actions for signing, building, DMG packaging, notarization, validation, and Sparkle releases.
    • Added support for generating signed appcast files, release archives, and optional update deltas.
    • Added comprehensive setup and usage documentation for the CI building blocks.
  • Chores

    • Added automated linting for GitHub Actions workflows.

Ship configure-signing, build, export-and-package, notarize-and-validate,
and sparkle-release for callers outside thaw-app via thaw-app/org-ci/...@sha.
Copilot AI review requested due to automatic review settings July 27, 2026 02:34
@diazdesandi
diazdesandi requested a review from a team as a code owner July 27, 2026 02:34
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@diazdesandi, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 46 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5185b2b5-d482-4a35-bf7b-fe9860fa3374

📥 Commits

Reviewing files that changed from the base of the PR and between 076270e and d8439b0.

📒 Files selected for processing (3)
  • actions/configure-signing/action.yml
  • actions/export-and-package/action.yml
  • actions/notarize-and-validate/action.yml
📝 Walkthrough

Walkthrough

Adds documented, SHA-pinned macOS release actions for signing, archiving, DMG packaging, notarization, validation, and Sparkle publication, plus an ActionLint workflow covering action and workflow changes.

Changes

macOS release pipeline

Layer / File(s) Summary
Action contracts and validation
.github/workflows/actionlint.yml, README.md
Documents action inputs, execution order, permissions, concurrency, signing paths, build constraints, and adds workflow linting.
Signing and notarization credential setup
actions/configure-signing/action.yml
Creates or uses a keychain, imports the Developer ID certificate, configures Apple tooling access, and stores NotaryTool credentials.
Developer ID archive build
actions/build/action.yml
Caches SwiftPM artifacts, validates project/workspace selection, and archives a macOS app with configurable signing and hardened runtime settings.
Archive export and DMG packaging
actions/export-and-package/action.yml
Exports the archive, retrieves optional branding assets, creates the DMG, and signs the app and disk image.
Notarization and validation
actions/notarize-and-validate/action.yml
Submits the DMG for notarization, checks acceptance, staples and validates it, and runs Gatekeeper assessment.
Sparkle release publication
actions/sparkle-release/action.yml
Creates a notarized ZIP, generates signed appcast and delta metadata, and optionally publishes appcast.xml to gh-pages with retries.

Estimated code review effort: 5 (Critical) | ~120 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Workflow
  participant ConfigureSigning
  participant Build
  participant ExportAndPackage
  participant NotarizeAndValidate
  participant SparkleRelease
  Workflow->>ConfigureSigning: configure signing credentials
  Workflow->>Build: archive macOS app
  Workflow->>ExportAndPackage: export archive and create signed DMG
  Workflow->>NotarizeAndValidate: submit and validate DMG
  Workflow->>SparkleRelease: generate and publish Sparkle release
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the addition of reusable macOS release composite actions under actions/.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/macos-release-actions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a set of reusable, parameterized composite GitHub Actions to standardize the macOS Developer ID release pipeline across thaw-app (and external consumer repos), with updated documentation on org-qualified, SHA-pinned usage.

Changes:

  • Document org-qualified uses: thaw-app/org-ci/...@<sha> patterns and action catalog in README.md.
  • Add composite actions for signing setup, Xcode archive build, DMG export/packaging, notarization/validation, and Sparkle release/appcast publishing.
  • Default DMG packaging art to thaw-app/brand-assets with override inputs.

Reviewed changes

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

Show a summary per file
File Description
README.md Documents how consumer repos should reference these actions and summarizes available composites.
actions/configure-signing/action.yml Composite for keychain setup, certificate import, and notarytool credential provisioning.
actions/build/action.yml Composite for xcodebuild archive with SwiftPM caching.
actions/export-and-package/action.yml Composite for exporting an archive and creating a signed DMG (optionally fetching brand assets).
actions/notarize-and-validate/action.yml Composite for notarytool submission, stapling, and Gatekeeper validation.
actions/sparkle-release/action.yml Composite for Sparkle ZIP packaging, appcast generation/signing, delta prep, and optional gh-pages publish.
Comments suppressed due to low confidence (1)

actions/notarize-and-validate/action.yml:40

  • This step depends on jq being available on the runner to parse notarytool JSON. That assumption holds on GitHub-hosted macOS runners, but it will fail on self-hosted/minimal images. Using python3 avoids the extra dependency and keeps set -euo pipefail behavior.
        status=$(echo "$submission" | jq -r '.status')

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread actions/export-and-package/action.yml
Comment thread actions/sparkle-release/action.yml
--wait)
echo "$submission"

submission_id=$(echo "$submission" | jq -r '.id')
Comment thread README.md
uses: thaw-app/org-ci/actions/sparkle-release@<sha>
```

`export-and-package` defaults to fetching DMG art from the public org repo [`thaw-app/brand-assets`](https://github.com/thaw-app/brand-assets). Override `brand-assets-repository` / `dmg-background` if needed.
Harden keychain search-list handling for bash 3.2, scrub Sparkle
private keys with umask/trap, retry gh-pages pushes, and tighten the
build/notarize contracts (workspace support, hardened runtime, env
inputs, shared keychain-path).
… Add

PlistBuddy cannot Add keys to a missing file; Clear dict first so the
export step works after rm -f.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/actionlint.yml:
- Around line 17-22: Pin the executable dependencies in the workflow: replace
actions/checkout@v7 with a reviewed full commit SHA and set persist-credentials
to false, then remove the mutable curl-piped actionlint bootstrap from the
“Download actionlint” step and use a released, checksum-verified actionlint
binary or a full-SHA-pinned actionlint action instead.

In `@actions/configure-signing/action.yml`:
- Around line 39-60: Harden the keychain setup around the cert.p12 creation and
security create-keychain commands: remove any existing keychain at the selected
keychain path before creating it, and register a trap immediately after creating
the temporary certificate so it is deleted on success or any subsequent failure.
Preserve the existing import and partition-list flow while ensuring cleanup runs
under set -euo pipefail.

In `@actions/export-and-package/action.yml`:
- Around line 22-29: Update the default value of brand-assets-ref to an
immutable, reviewed tag or commit SHA instead of the floating main branch, while
preserving the existing input description and optional-input behavior.
- Around line 111-121: Update the create-dmg invocation in the packaging step to
tolerate transient hdiutil/Finder “Resource busy” failures by using the
supported --hdiutil-retries option or an equivalent retry loop with backoff.
Ensure the command only fails after the configured retries are exhausted so set
-euo pipefail does not abort codesign on a transient error.

In `@actions/notarize-and-validate/action.yml`:
- Around line 46-55: Update the notarization handling around the notarytool log
invocation and status check so a log-fetch failure cannot bypass the
status-based outcome reporting. Ensure the status from submission is evaluated
and the descriptive “Notarization failed with status” path runs before or
independently of fetching logs, while preserving log retrieval for accepted
submissions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d84eb365-e0f2-43cd-a040-469390e86c9d

📥 Commits

Reviewing files that changed from the base of the PR and between c9fe800 and 076270e.

📒 Files selected for processing (7)
  • .github/workflows/actionlint.yml
  • README.md
  • actions/build/action.yml
  • actions/configure-signing/action.yml
  • actions/export-and-package/action.yml
  • actions/notarize-and-validate/action.yml
  • actions/sparkle-release/action.yml

Comment thread .github/workflows/actionlint.yml
Comment thread actions/configure-signing/action.yml Outdated
Comment thread actions/export-and-package/action.yml Outdated
Comment thread actions/export-and-package/action.yml
Comment thread actions/notarize-and-validate/action.yml
Delete stale keychains and trap-clean cert.p12; evaluate notary status
before log fetch; pin brand-assets-ref and pass --hdiutil-retries.

@diazdesandi diazdesandi left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

.

@diazdesandi
diazdesandi merged commit 914db7d into main Jul 27, 2026
3 checks passed
@diazdesandi
diazdesandi deleted the chore/macos-release-actions branch July 27, 2026 05:02
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