Skip to content

docs: add distribution channels and workflow to RELEASE.md - #8681

Open
itaybre wants to merge 1 commit into
mainfrom
docs/release-distribution
Open

docs: add distribution channels and workflow to RELEASE.md#8681
itaybre wants to merge 1 commit into
mainfrom
docs/release-distribution

Conversation

@itaybre

@itaybre itaybre commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Description

Add a "Distribution Channels" section to develop-docs/RELEASE.md documenting:

  • Current distribution via SPM only (CocoaPods and Carthage removed)
  • All Craft release targets (GitHub Release, 5 downstream repos, release registry)
  • Release workflow steps (build slices, assemble XCFrameworks, validate, create archives, Craft publish)
  • Cross-reference to MIRRORING.md for continuous sync details

#skip-changelog

Closes #8682

Document current release targets (SPM, Carthage, downstream
repos via Craft), note CocoaPods removal, and outline the
release workflow steps including XCFramework assembly,
archive creation, and Craft publishing.
Comment thread develop-docs/RELEASE.md
| `getsentry/sentry-apple-swiftybeaver` | 3rd-party integration mirror |
| Sentry Release Registry | Updates the `cocoapods:sentry-cocoa` entry (historical name) |

The 3rd-party integration repos also receive continuous code sync on every push to `main`. See [MIRRORING.md](MIRRORING.md) for full details on both mechanisms.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: The RELEASE.md file contains a broken link to MIRRORING.md, which does not exist in the repository.
Severity: LOW

Suggested Fix

Either create the missing MIRRORING.md file with the relevant documentation content or remove the broken link from develop-docs/RELEASE.md if the documentation is not available.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: develop-docs/RELEASE.md#L25

Potential issue: The documentation file `develop-docs/RELEASE.md` at line 25 contains a
relative link to `MIRRORING.md`. However, this file does not exist anywhere in the
repository. When a user clicks this link in the rendered Markdown, they will encounter a
404 error page instead of the intended documentation about code mirroring mechanisms.
This is a documentation integrity issue.

Did we get this right? 👍 / 👎 to inform future reviews.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is added in #8679

@itaybre itaybre added the run-full-ci Allows gated GitHub Action workflows to run for a labelled pull request label Aug 4, 2026

@philprime philprime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@NinjaLikesCheez NinjaLikesCheez left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, 2 small suggestions for you to consider.

Comment thread develop-docs/RELEASE.md

## Distribution Channels

The SDK is distributed via **SPM**. CocoaPods and Carthage support were removed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The SDK is distributed via **SPM**. CocoaPods and Carthage support were removed.
The SDK is distributed via **SPM**. CocoaPods and Carthage support has been removed.

Comment thread develop-docs/RELEASE.md
Comment on lines +17 to +22
| GitHub Release | Source + XCFramework zips on the [releases page](https://github.com/getsentry/sentry-cocoa/releases/) |
| `getsentry/sentry-apple-binaries` | Pre-built XCFrameworks with a `Package.swift` for SPM binary targets |
| `getsentry/sentry-apple-swift-log` | 3rd-party integration mirror |
| `getsentry/sentry-apple-cocoalumberjack` | 3rd-party integration mirror |
| `getsentry/sentry-apple-pulse` | 3rd-party integration mirror |
| `getsentry/sentry-apple-swiftybeaver` | 3rd-party integration mirror |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
| GitHub Release | Source + XCFramework zips on the [releases page](https://github.com/getsentry/sentry-cocoa/releases/) |
| `getsentry/sentry-apple-binaries` | Pre-built XCFrameworks with a `Package.swift` for SPM binary targets |
| `getsentry/sentry-apple-swift-log` | 3rd-party integration mirror |
| `getsentry/sentry-apple-cocoalumberjack` | 3rd-party integration mirror |
| `getsentry/sentry-apple-pulse` | 3rd-party integration mirror |
| `getsentry/sentry-apple-swiftybeaver` | 3rd-party integration mirror |
| GitHub Release | Source + XCFramework zips on the [releases page](https://github.com/getsentry/sentry-cocoa/releases/) |
| [`getsentry/sentry-apple-binaries`](https://github.com/getsentry/sentry-apple-binaries) | Pre-built XCFrameworks with a `Package.swift` for SPM binary targets |
| [`getsentry/sentry-apple-swift-log`](https://github.com/getsentry/sentry-apple-log) | 3rd-party integration mirror |
| [`getsentry/sentry-apple-cocoalumberjack`](https://github.com/getsentry/sentry-apple-cocoalumberjack) | 3rd-party integration mirror |
| [`getsentry/sentry-apple-pulse`](https://github.com/getsentry/sentry-apple-pulse) | 3rd-party integration mirror |
| [`getsentry/sentry-apple-swiftybeaver`](https://github.com/getsentry/sentry-apple-swiftybeaver] | 3rd-party integration mirror |

Just to make life easier for future me when I need/want to click these heh

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

Labels

approved run-full-ci Allows gated GitHub Action workflows to run for a labelled pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add distribution channels and workflow to RELEASE.md

3 participants