release-preparation

name	release-preparation
description	Use only when the user has explicit Mos release intent and the task requires a release action: version/build bump, release archive, Developer ID signing, notarization, release zip packaging, changelog generation, Sparkle appcast signing/update, or GitHub release draft creation.

Release Preparation

Full release pipeline: bump version → build → sign → notarize → package zip → generate changelog → sign appcast → create GH draft.

Trigger Rule

Use this skill only when both conditions are true:

• The user has explicit release intent.
• The task requires at least one release action: version/build bump, release archive, Developer ID signing, notarization, release zip packaging, changelog generation, Sparkle appcast signing/update, or GitHub release draft creation.

If the task does not require a release artifact or appcast update, stay in the normal development workflow and choose validation based on the changed files.

When this skill is not active, high-risk release confirmations are not part of the final report by default. Mention only checks, blockers, and residual risks that are directly relevant to the request.

Inputs

Input	Source
Mos.app	Built via xcodebuild archive + Developer ID export (Step 0)
Version / Build	MARKETING_VERSION / CURRENT_PROJECT_VERSION in Mos.xcodeproj/project.pbxproj
Channel	User specifies: stable, beta, or alpha
Signing key	macOS Keychain — Apple Developer ID (code signing) + Sparkle EdDSA (appcast)
Notarization	macOS Keychain profile notarytool (stores Apple ID + app-specific password)

Non-Negotiable Release Gates

• CURRENT_PROJECT_VERSION is a release-blocking field, not an optional cleanup item. If the user asks to prepare a release and the channel/version are known or inferable, bump the build before archive/sign/notarize/package work.
• Every release artifact must use a unique CURRENT_PROJECT_VERSION in YYYYMMDD.N format. Sparkle compares this value as sparkle:version; reusing an older build number can make the new update invisible to users.
• The build must change even when MARKETING_VERSION stays the same, including hotfixes, re-runs, and same-version releases.
• Choose the build from the release date (YYYYMMDD.1 by default); if another release/build already uses that value, increment .N.
• After editing, verify both CURRENT_PROJECT_VERSION occurrences in Mos.xcodeproj/project.pbxproj match. Do not phrase this step to the user as optional.

Absolute Stop: Draft Only

• Agents may create or update a GitHub draft release only. Never publish a formal release, undraft a release, or run any command that makes the release public.
• Forbidden autonomous commands include gh release edit --draft=false, gh release edit --latest, deleting/recreating a public release to simulate publishing, or using any GitHub UI/API path that changes a draft into a published release.
• Pushing release/appcast commits is also a separate user-confirmed step. Do not run git push during draft creation.
• After creating and verifying the draft, stop and hand off to the user for GitHub review. Proactively remind the user not to publish the GitHub release before release/version/appcast commits and the release tag have been committed and pushed.

Flow

digraph release {
  rankdir=TB;
  node [shape=box];

  "0. Build, sign & notarize" -> "1. Package zip";
  "1. Package zip" -> "2. Generate changelog";
  "2. Generate changelog" -> "3. Interactive confirm";
  "3. Interactive confirm" -> "4. Sign & update appcast";
  "4. Sign & update appcast" -> "5. Commit appcast";
  "5. Commit appcast" -> "6. Create GH draft";
  "6. Create GH draft" -> "7. Verify";
  "7. Verify" -> "8. User-confirmed push + human publish";
}

Step 0: Build, Sign & Notarize

1. Bump version in Mos.xcodeproj/project.pbxproj:

   • MARKETING_VERSION — e.g., 4.0.2 (appears twice, use replace_all)
   • CURRENT_PROJECT_VERSION — build number in YYYYMMDD.N format (appears twice, use replace_all). CRITICAL: Every release MUST have a unique CURRENT_PROJECT_VERSION. Sparkle uses this value (sparkle:version) to detect updates — if two releases share the same build number, users on the older version will never see the update. Always bump this even for hotfix releases, and treat a stale/unchanged build as a blocker before archive.
   • Verify the project now contains exactly two matching CURRENT_PROJECT_VERSION values and the intended MARKETING_VERSION.
   • Commit the version bump.

2. Archive:

   xcodebuild archive \
     -scheme Debug \
     -project Mos.xcodeproj \
     -configuration Release \
     -archivePath /tmp/Mos.xcarchive
   

   Note: The scheme is named "Debug" but -configuration Release ensures Release build settings.

3. Export with Developer ID (Direct Distribution):

   cat > /tmp/ExportOptions.plist << 'PLIST'
   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
   <plist version="1.0">
   <dict>
     <key>method</key><string>developer-id</string>
     <key>teamID</key><string>N7Z52F27XK</string>
     <key>signingStyle</key><string>automatic</string>
   </dict>
   </plist>
   PLIST
   
   xcodebuild -exportArchive \
     -archivePath /tmp/Mos.xcarchive \
     -exportOptionsPlist /tmp/ExportOptions.plist \
     -exportPath /tmp/MosExport \
     -allowProvisioningUpdates
   

   If export fails with "network connection was lost", retry — Apple's notarization service can be flaky.

4. Notarize (xcodebuild -exportArchive does NOT auto-notarize via CLI — must always do manually):

   # Note: this zip is only for notarization submission, not for distribution.
   
   ditto -c -k --keepParent /tmp/MosExport/Mos.app /tmp/Mos-notarize.zip
   xcrun notarytool submit /tmp/Mos-notarize.zip --keychain-profile  --
   xcrun stapler staple /tmp/MosExport/Mos.app
   

The notarized app at /tmp/MosExport/Mos.app is used for Step 1.

Step 1: Package Zip

bash scripts/release/prepare_zip.sh /tmp/MosExport/Mos.app [--channel beta]

Returns JSON with zip_path, version, build, tag, zip_name, length.

IMPORTANT — AppleDouble / Gatekeeper: The script uses ditto -c -k --norsrc --noextattr --keepParent to create the zip. The --norsrc --noextattr flags are mandatory — without them, ditto serializes macOS extended attributes as AppleDouble (._*) files inside the zip. When users extract via Finder/Archive Utility (not ditto -x -k), these ._* entries appear as real files in embedded framework root directories (e.g., Sparkle.framework/._Autoupdate), causing Gatekeeper to reject with "unsealed contents present in the root directory of an embedded framework". This issue is not detectable by spctl --assess on the build machine because ditto -x -k correctly reconverts ._* files back to xattrs — only Finder extraction triggers the failure.

After packaging, verify the zip is clean:

# Must show NO ._* entries
zipinfo -1 "$ZIP_PATH" | grep '/\._' && echo "ERROR: AppleDouble files found!" || echo "OK: no AppleDouble files"

Step 2: Generate Changelog

This is AI work, not scripted. Follow these rules:

1. Find last release tag:

   gh release list --repo Caldis/Mos --limit 1 --json tagName,isPrerelease
   git rev-parse <tag>  # get exact commit SHA
   

2. Get changes: git log <last_tag>..HEAD --no-merges --oneline excluding website/, docs/, release/, .issues-archive/, AGENTS.md, CLAUDE.md, LOCALIZATION.md, .agents/, .claude/, .codex/, .skills/, build/, packaging/, CRASH_FIX_DESIGN*.
3. Categorize into: 新功能/New Features, 优化/Improvements, 修复/Fixes.
4. Find contributors: cross-reference git log --format="%an" with gh api repos/.../commits/<sha> --jq '.author.login'. Inline credit in the relevant section (e.g., "修复鼠标中键映射问题, 感谢 @GonzFC"), NOT in a separate section.
5. Match tone of CHANGELOG.md — bilingual (Chinese first, --- separator, then English).
6. Write both formats:
   • Markdown → ~/Desktop/release-notes-{version}.md (for GH release body). Must include wiki links header before each language section:

     > 如果应用无法启动或遇到权限问题, 请参考 [Wiki: 如果应用无法正常运行](https://github.com/Caldis/Mos/wiki/%E5%A6%82%E6%9E%9C%E5%BA%94%E7%94%A8%E6%97%A0%E6%B3%95%E6%AD%A3%E5%B8%B8%E8%BF%90%E8%A1%8C)
     
     ## 修复
     - ...
     
     ---
     
     > If the application fails to start or encounters permission issues, please refer [Wiki: If the App not work properly](https://github.com/Caldis/Mos/wiki/If-the-App-not-work-properly)
     
     ## Fixes
     - ...
     

   • HTML → /tmp/changelog-{version}.html (for appcast CDATA). Use <h2> + <ul><li>, with <hr/> separating Chinese and English:

     修复
     
     修复平滑滚动导致的崩溃问题
     
     
     
     
     Fixes
     
     Fix crash caused by smooth scrolling
     
     

Step 3: Interactive Confirm

MUST use the current agent platform's interactive confirmation tool to confirm changelog items (for example, Claude Code AskUserQuestion, or Codex's user-input flow when available). Never list items as text and ask user to type numbers.

After confirmation, sync any user edits from markdown back to HTML. Always keep both formats in sync.

Step 4: Sign & Update Appcast

bash scripts/release/update_appcast.sh <zip_path> /tmp/changelog-{version}.html [--tag TAG]

Uses Sparkle sign_update from Xcode DerivedData (reads EdDSA key from Keychain). If key missing, guide user:

# Find generate_keys tool
find ~/Library/Developer/Xcode/DerivedData -name "generate_keys" -not -path "*/checkouts/*" | head -1
# Import: generate_keys -f <key_file>
# Export: generate_keys -x <output_file>

The script writes to both build/appcast.xml and release/appcast.xml.

Step 5: Commit Appcast

Only release/appcast.xml is tracked by git (build/ is gitignored):

git add release/appcast.xml
git commit -m "chore: update appcast for {version}"

Step 6: Create GitHub Draft

bash scripts/release/create_gh_draft.sh <tag> <zip_path> ~/Desktop/release-notes-{version}.md [--prerelease]

Add --prerelease for beta/alpha channels. This creates a draft — never publish without user approval.

Step 7: Verify

gh release view <tag> --repo Caldis/Mos --json tagName,isDraft,assets \
  --jq '{tag: .tagName, draft: .isDraft, assets: [.assets[] | {name: .name, size: .size}]}'

Confirm asset URL matches appcast <enclosure url="...">.

Step 8: User-Confirmed Push + Human Publish

Stop here and ask the user to review the draft on GitHub. Do not publish the release, run gh release edit --draft=false, or run git push as part of the autonomous release command sequence.

Before the user publishes the draft, proactively remind them:

• Do not click Publish release before the release/version/appcast commits are committed and pushed.
• Push the final release branch and ensure the release tag points to the final release commit first; only then should the user manually publish the GitHub release.
• If the user has already published first, immediately verify remote branch/tag/release alignment and fix only with explicit user confirmation.

Only after the user explicitly confirms the draft has been reviewed and asks to synchronize code/tag before publishing:

git push origin master

This pushes the appcast update so Sparkle auto-update can find it. Create or update the release tag only with explicit user confirmation, then hand off to the user for the formal GitHub release publish action.

Naming Conventions

	Stable	Beta/Alpha
Zip	Mos.Versions.{ver}-{YYYYMMDD.N}.zip	Mos.Versions.{ver}-beta-{YYYYMMDD.N}.zip
Tag	{ver}	{ver}-beta-{YYYYMMDD.N}
Download URL	.../download/{ver}/Mos.Versions...zip	.../download/{ver}-beta-.../Mos.Versions...zip

Common Issues

Problem	Fix
Export fails with "network connection was lost"	Retry — Apple notarization service can be intermittent
spctl --assess rejected after export	Notarization not auto-applied; manually submit with notarytool + stapler staple
sign_update not found	Build project in Xcode first to fetch Sparkle SPM package
Signing key not in Keychain	Use generate_keys -f <key_file> to import Sparkle EdDSA key
Developer ID cert missing from security find-identity	Download from Apple Developer portal or use Xcode → Settings → Accounts → Manage Certificates
Appcast URL mismatch	Verify GH release tag matches appcast <enclosure> URL path
Changelog out of sync	Always edit markdown first, then regenerate HTML before updating appcast
Sparkle update not detected	Each release MUST have a unique CURRENT_PROJECT_VERSION (= sparkle:version). Sparkle compares this value, not MARKETING_VERSION. If two releases share the same build number, users will never see the update.
Gatekeeper rejects downloaded app ("Apple 无法验证")	Zip likely contains AppleDouble ._* files. Verify with zipinfo -1 <zip> | grep '/\._'. Fix: use ditto -c -k --norsrc --noextattr --keepParent (already in prepare_zip.sh). Note: spctl --assess on build machine won't catch this — only Finder extraction triggers failure.
COPYFILE_DISABLE=1 doesn't work with ditto	This env var only works with cp, tar, etc. For ditto, use --norsrc --noextattr flags instead.