docs: fix stale release/build instructions and rewrite devbox guide#1285
Merged
Conversation
5725caa to
ec79f46
Compare
Contributor
Author
|
Updated: renamed |
ec79f46 to
f26d82e
Compare
Rename wiki/release.md -> root RELEASING.md to match the convention used across the other Segment SDK repos (analytics-swift, -kotlin, -next), and update its references in CONTRIBUTING.md and wiki/devbox.md. CONTRIBUTING.md: - Replace nonexistent `yarn bootstrap` with `devbox shell` / `yarn install` - `yarn typescript` -> `yarn typecheck` (script was renamed) - Replace removed `yarn e2e ...` commands with the Devbox/Detox flow in the example workspaces; fix `/example/` paths to examples/AnalyticsReactNativeExample - Release section: name the actual `Release` workflow (was `Publish`) and its dry-run/beta/production types RELEASING.md (moved from wiki/release.md): - Drop the nonexistent `--config=shells/devbox-fast.json` flag from the sync-versions and release-dry-run commands (scripts live in root devbox.json) wiki/devbox.md: - Rewrite to reflect that Android/iOS SDK, emulator/simulator, and device management moved into the segment-integrations/mobile-devtools Devbox plugins consumed by the example workspaces; the root env is now build/test/release only - Remove dead references to nix/, shells/, and examples/E2E/ - Correct the Releases note: npm publishing uses OIDC trusted publishing, not NPM_TOKEN Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
f26d82e to
0b51a04
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes stale release/build documentation that no longer matches
master. All findings were verified against the actual CI workflow (.github/workflows/release.yml), root and exampledevbox.jsonscripts, andpackage.jsonbefore editing — no speculative changes.CONTRIBUTING.mdyarn bootstrapdoes not exist. Replaced withdevbox shell(init hook runsyarn install) or plainyarn install.yarn typescript→yarn typecheck(the script was renamed; the old name errors out).yarn e2e …command set no longer exists. Replaced with the current Devbox/Detox flow run from the example workspaces (examples/e2e-latest,examples/e2e-compat), plus a pointer toexamples/SHARED_E2E_SETUP.md./example/→examples/AnalyticsReactNativeExample/(the old top-level dir is gone; only theexamples/tree exists).Publish, which is actually the unrelated Publish E2E CLI). Corrected to theReleaseworkflow and itsdry-run/beta/productiontypes.wiki/release.md--config=shells/devbox-fast.jsonflag from thesync-versionsandrelease-dry-runcommands. There is noshells/directory; those scripts live in the rootdevbox.jsonand CI invokes them asdevbox run <script>.wiki/devbox.md(rewrite)The old guide described an architecture that has since moved out of this repo. The Android/iOS SDK provisioning, emulator/simulator management, and device definitions now live in the reusable Devbox plugins in
segment-integrations/mobile-devtools, consumed by the example workspaces viainclude. The rewrite:nix/,shells/,examples/E2E/, andci-e2e-full.yml.start:emu/start:sim/start:android/start:ios,doctor, etc.) and the committeddevbox.d/device lock files.NPM_TOKEN.Validation
master(and inmobile-devtoolsfor the plugin references).Notes for reviewers
wiki/scripts.mdandwiki/nix.mdmay contain related stale references (e.g. toshells//nix/); I scoped this PR to the release/build-facing docs. Happy to follow up on those separately.🤖 Generated with Claude Code