Skip to content

fix(instances): name the Platform API key variables for mobile verification - #10

Merged
mikepitre merged 2 commits into
mainfrom
mobile-verification-key-name
Nov 3, 2026
Merged

mikepitre merged 2 commits into
mainfrom
mobile-verification-key-name

Conversation

@mikepitre

Copy link
Copy Markdown
Collaborator

What & why

  • The CLI read the team Platform API key from CLERK_PLATFORM_API_KEY. That's also the name clerk/javascript's web integration suite uses for a different key, so a shell set up for those tests would send the mobile CLI's throwaway apps to the wrong workspace.
  • The three ways to supply the key now match the MOBILE_VERIFICATION_PLATFORM_API_KEY secret that consumer CI already reads: MOBILE_VERIFICATION_PLATFORM_API_KEY, MOBILE_VERIFICATION_PLATFORM_API_KEY_FILE, and MOBILE_VERIFICATION_PLATFORM_API_KEY_REFERENCE (was VERIFY_PLATFORM_KEY_REFERENCE). No fallback to the old names.

Testing

  • npm run build, then node --test test/*.test.ts: 736 pass. tsc -p . is clean.

Risk

  • Anyone who sets the old variables locally gets KEYS_MISSING until they rename them. The error's fix line names the new variables.
  • Cloud sessions aren't affected: their key is added to requests by host and path, not read from a variable.
  • Consumers pick this up only when they bump their pin, in the clerk-ios, clerk-android, and clerk/javascript PRs that follow.

How to revert

  • A plain revert, plus reverting the consumer pin bumps.

🤖 Generated with Claude Code

…cation

CLERK_PLATFORM_API_KEY is the name clerk/javascript's web integration suite
already uses for its own key, so a shell set up for those tests would point
the mobile CLI at the wrong workspace. Rename the three ways to supply the
key to match the MOBILE_VERIFICATION_PLATFORM_API_KEY secret:
MOBILE_VERIFICATION_PLATFORM_API_KEY, _FILE and _REFERENCE (was
VERIFY_PLATFORM_KEY_REFERENCE).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

The Platform API credential variables now use the MOBILE_VERIFICATION_PLATFORM_* names. Runtime lookup, launch configuration, documentation, and test fixtures use the updated names. Credential precedence, file checks, and tested behavior remain unchanged.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: wobsoriano

Merge Risk: Minimal · up to 0889a

The credential rename is ready to merge with the dependent workflow update; legacy variable users must still migrate their environment names.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title clearly identifies the main change: renaming the Platform API key variables for mobile verification.
Description check Passed The description explains the variable renames, the reason for the change, compatibility impact, testing, risk, and revert plan. It directly relates to the changeset.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 6 functions across 5 files.

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Linked repositories: Some configured repositories could not be included in this review. Cross-repository analysis may be incomplete. Please check linked-repository access and settings.

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Team
  • Run ID: 4a0559f4-a00a-4727-a9e9-c1c8d3143c08
Commits

Reviewing files that changed from the base of the PR and between b70b190 and 0889a2d.

Files selected for processing: 2
  • src/core/launch.mjs
  • test/instances.test.ts
Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

Included review availability: This review used your included allowance. 1 included review remains after this review. Your included PR review attempts over the past 7 days set your current allowance at 6 reviews per hour.

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread src/core/instances/platform.ts Resolved
Comment thread src/core/launch.mjs Resolved
… child processes

The CLI reads only the MOBILE_VERIFICATION_ names, but a shell can still
hold CLERK_PLATFORM_API_KEY for clerk/javascript's web suite, or the old
names. Strip those from every child environment too, without reading them
as the key.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mikepitre
mikepitre merged commit 4927460 into main Nov 3, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant