chore(ci): record published version in the SDK release catalog (SDK-7358) [v8] - #205
Open
shivam5643 wants to merge 2 commits into
Open
shivam5643 wants to merge 2 commits into
shivam5643 wants to merge 2 commits into
Conversation
…358) railsApp derives a version's tier (stable/outdated/deprecated) from the sdk_version_releases catalog. Without a callback from the release path the catalog only advances when someone re-runs the registry backfill, so a version published today looks missing and its age clock never starts. This service publishes from GitHub Actions rather than browserstack-cd, so the hook the other SDKs get from the Jenkins pipeline has to live here. Recorded under language `ecmascript` -- a separate catalog line from `node`. Driven off changesets' `published`/`publishedPackages` outputs rather than re-deriving the version, so it fires only when something was actually published -- not when the action opens the Version PR instead. Canary is excluded by the same gate. Never fails a release: continue-on-error, a guard for the missing credential, and version validation before the call. A failed write costs freshness, not correctness -- rake sdk_release_catalog:backfill recovers anything missed. Inert until the SDK_RELEASE_SERVICE_CREDS secret is provisioned; it logs a warning and exits 0. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
shivam5643
requested review from
kamal-kaur04 and
rounak610
and removed request for
a team
September 16, 2026 18:22
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited), Workspace UI (inherited) Review profile: ASSERTIVE Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
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.
What is this about?
Adds the SDK-7358 release-catalog callback to the release workflow — v8 line.
Clean cherry-pick of #204 (v9 /
main); the resultingrelease.ymlis byte-identical across both lines.railsApp derives a version's tier — stable / outdated / deprecated — from the
sdk_version_releasescatalog. The catalog is seeded by a one-shot backfill that scrapes thepublic registries. Without a callback from the release path it only advances when someone
re-runs that backfill, so a version published today looks missing to railsApp: customers on
it get no nudge, and its age clock never starts.
The equivalent hook for node, java, python and ruby lives in
browserstack-cd, because thosefour publish from Jenkins. This service publishes from GitHub Actions, so its hook has to
live here. (The old Jenkins job
WdioServiceNpmPackagePublishwas disabled on 2026-08-19 perSDK-6957/APPSEC-537 and is not the hook point; the preprod packers only upload tarballs and
never
npm publish.)Recorded under language
ecmascript— a separate catalog line fromnode. Sendingnodehere would merge this service's releases into the node-agent catalog.
Two design points worth a reviewer's eye:
steps.publish.outputs.published/publishedPackagesfrom the pinnedchangesets/actionrather than re-deriving the version, so it fires only when somethingwas actually published. When changesets are still pending the action opens the Version PR
and publishes nothing — this step correctly stays silent.
main(v9 →latest) and onv8(→v8dist-tag), so no branch special-casing. Canary is excluded by the sameif:,which matters because a canary version string (
9.30.0-canary-<datetime>) would exceed theendpoint's 20-character limit anyway.
This is inert until the secret is provisioned. Without
SDK_RELEASE_SERVICE_CREDSit logsa warning and exits 0, so it is safe to merge ahead of the credential.
Related Jira task/s
Release (mandatory for every PR — required for the
ready-for-reviewlabel)Version bump: (required — tick exactly one)
Release notes type: (optional)
Release notes (customer-facing): (optional but encouraged)
Release notes (internal): (required — engineer-facing; what actually changed / why)
id: publishto the existingPublish to npmstep so its outputs can be referenced.Record release in the SDK version catalogstep that POSTs{language: "ecmascript", version, release_date}to/sdk/v1/admin/releases, gated onsteps.publish.outputs.published == 'true'.continue-on-error: true, a guard for the missing credential, and a version-format check before the call.409(already recorded with a different date) is surfaced as a warning to investigate rather than forced.Checklist
PR Validations
Run Tests: Comment RUN_TESTS to trigger sanity tests.
Testing
Publish to npm, before the canary step) andid=publishconfirmed present.release.ymlis byte-identical across both lines.SDK_RELEASE_SERVICE_CREDSsecret does not exist in this repo. The Jenkins hook reads the credential from Vault; GitHub runners have no Vault, so it must be provisioned separately as an Actions secret (value:client_id:client_secret).workflow_dispatchthat just prints the HTTP code. A401/503is a success for that test; a timeout or WAF page is not.Pairs with #204 (v9). Suggest enabling v9 first, then this one.
🤖 Generated with Claude Code