Skip to content

docs: add mirroring documentation - #8679

Open
itaybre wants to merge 1 commit into
mainfrom
docs/mirroring
Open

docs: add mirroring documentation#8679
itaybre wants to merge 1 commit into
mainfrom
docs/mirroring

Conversation

@itaybre

@itaybre itaybre commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Description

Document how code and releases are mirrored to downstream repositories (e.g., sentry-apple-swift-log, sentry-apple-binaries).

Covers:

  • Downstream repo table with sync mechanisms
  • Continuous code sync via the mirror workflow (sentry-mobile-updater)
  • Release-time distribution via Craft
  • Step-by-step guide for adding new downstream mirrors, including the required repo ruleset change for sentry-mobile-updater

Motivation

This information was scattered across workflow files, .craft.yml, and tribal knowledge. Having it in one place makes onboarding and adding new integrations easier.

#skip-changelog

Closes #8680

Document how code and releases are mirrored to
downstream repositories, covering continuous sync
via the mirror workflow and release-time distribution
via Craft, including setup steps for new mirrors.
@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.

Approved as this is a docs PR, but left a question where with ask for insights

Comment thread develop-docs/MIRRORING.md

1. Builds XCFrameworks.
2. Creates `.tgz` archives via [`scripts/create-apple-binaries-archive.sh`](../scripts/create-apple-binaries-archive.sh) and [`scripts/create-3rd-party-integration-archive.sh`](../scripts/create-3rd-party-integration-archive.sh).
3. Craft pushes each archive to its downstream repo on the `main` branch and creates a Git tag matching the release version.

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.

m: Does this mean that craft is pushing code which is then overwritten again by the continuous sync? If yes, what is the value of using craft to publish the archive here?

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 mirroring documentation

2 participants