orbitdock-release-notes

OrbitDock Release Notes

Overview

Write and update OrbitDock release notes in a consistent, high-signal format. Use gh and git as the source of truth before publishing edits. For OrbitDock Native TestFlight notes, assume one shared app experience first and only split by platform when the diff proves a meaningful user-facing difference.

Modes

Choose one mode before gathering inputs:

• tag-release mode: Stable GitHub release notes for tagged versions (for example, v0.10.0 -> v0.11.0).
• build-train mode: TestFlight changelogs for emoji build markers that are commit subjects, not tags (for example, 🔖 v0.7.0-b7 -> 🔖 v0.7.0-b8).

Gather Inputs

Tag-release mode

Collect these inputs:

• Target tag (for example, v0.11.0).
• Previous stable tag for compare link (for example, v0.10.0).
• Existing body and assets:
  • gh release view <tag> --repo Robdel12/OrbitDock --json body,assets,name,tagName,url
• Compare stats for the intro paragraph:
  • gh api repos/Robdel12/OrbitDock/compare/<prev>...<tag> --jq '{total_commits,ahead_by,files:(.files|length),insertions:([.files[].additions]|add),deletions:([.files[].deletions]|add)}'
• Optional deeper signal for highlight themes:
  • gh api repos/Robdel12/OrbitDock/compare/<prev>...<tag> --jq '.commits[].commit.message'

Build-train mode (TestFlight)

Collect these inputs:

• Source marker and destination marker (for example, 🔖 v0.7.0-b7 and 🔖 v0.7.0-b8).
• Resolve marker commit SHAs:
  • BASE_SHA=$(git rev-list --all --max-count=1 --grep='^🔖 v0\\.7\\.0-b7')
  • HEAD_SHA=$(git rev-list --all --max-count=1 --grep='^🔖 v0\\.7\\.0-b8')
• Confirm range stats:
  • git diff --shortstat "$BASE_SHA..$HEAD_SHA"
  • git log --oneline --no-merges "$BASE_SHA..$HEAD_SHA"
• Optional release lookup by display name (if needed):
  • gh api repos/Robdel12/OrbitDock/releases --paginate --jq '.[] | select(.name=="🔖 v0.7.0-b8") | {name,tag_name,target_commitish,published_at,url}'

Only gather platform-specific signal when the diff or the user suggests meaningful divergence: