Move Temporal CLI Cloud extension to Public Preview - #5151
Draft
lennessyy wants to merge 3 commits into
Draft
Conversation
Flip the cloudCli release stage to publicPreview, which updates the ReleaseNoteHeader on /cli/cloud and all 18 cloud command reference pages. Add Temporal CLI tabs alongside every tcld command example in the Cloud docs, with `temporal cloud` as the default tab.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
📖 Docs PR preview links
|
Contributor
There was a problem hiding this comment.
Pull request overview
Promotes the Temporal CLI Cloud extension to Public Preview and expands Cloud documentation with equivalent temporal cloud commands.
Changes:
- Updates the extension’s release-stage label.
- Adds Temporal CLI tabs alongside
tcldexamples. - Revises Cloud setup and management guidance.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
src/constants/featureReleaseTypes.js |
Promotes the extension to Public Preview. |
docs/cli/setup-cli.mdx |
Updates release-stage guidance. |
docs/troubleshooting/last-connection-error.mdx |
Adds certificate inspection command. |
docs/develop/typescript/nexus/feature-guide.mdx |
Adds Temporal CLI Nexus commands. |
docs/develop/python/nexus/feature-guide.mdx |
Adds Temporal CLI Nexus commands. |
docs/develop/java/nexus/feature-guide.mdx |
Adds Temporal CLI Nexus commands. |
docs/develop/go/nexus/feature-guide.mdx |
Adds Temporal CLI Nexus commands. |
docs/develop/dotnet/nexus/feature-guide.mdx |
Adds Temporal CLI Nexus commands. |
docs/cloud/terraform-provider.mdx |
Adds CLI validation examples. |
docs/cloud/manage-access/service-accounts.mdx |
Documents Service Account commands. |
docs/cloud/high-availability/failovers/manage.mdx |
Adds a failover command. |
docs/cloud/high-availability/enable.mdx |
Adds High Availability commands. |
docs/cloud/get-started/user-invite.mdx |
Adds a user invitation command. |
docs/cloud/get-started/namespaces.mdx |
Expands Namespace CLI guidance. |
docs/cloud/get-started/api-keys.mdx |
Adds API key commands. |
docs/cloud/gcp-export-gcs.mdx |
Adds GCS export commands. |
docs/cloud/connectivity/index.mdx |
Adds connectivity commands. |
docs/cloud/capacity-modes.mdx |
Adds capacity configuration commands. |
docs/cloud/aws-export-s3.mdx |
Adds S3 export commands. |
Suppressed comments (1)
docs/cloud/terraform-provider.mdx:87
- After removing the
tcldprefix, this names a nonexistent genericapikey createcommand: Temporal CLI usesapikey create-for-me, whiletcldusesapikey create. Name both commands so users know how to obtain the secret.
# replace <your-secret-key> with the "secretKey": output from the apikey create command
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+281
to
+283
| temporal cloud namespace ha update \ | ||
| --namespace <namespace_id>.<account_id> \ | ||
| --disable-auto-failover |
| // ReleaseNoteHeader label resolution. Keep in sync when adding feature mappings. | ||
| export const FEATURE_RELEASE_TYPES = { | ||
| cloudCli: "prerelease", | ||
| cloudCli: "publicPreview", |
| </Tabs> | ||
|
|
||
| To restore the default behavior, unselect the option in the Web UI or change `true` to `false` in the CLI command. | ||
| To restore the default behavior, unselect the option in the Web UI or pass `--disable-auto-failover=false` in the CLI command. |
| --region <target_region> | ||
| ``` | ||
|
|
||
| The `<target_region>` must be the name of a region (example: `us-east-1`) where the Namespace has a replica that is |
| --region <replica_region> | ||
| ``` | ||
|
|
||
| Specify the region name (for example, `us-east-1`) of the region where you want to create the replica as an argument to |
|
|
||
| This example creates a Service Account with the name `sa_test`, description `this is a test SA`, and a `read` Account Role. | ||
|
|
||
| Creating a Service Account requires `--name` and `--account-role`. |
Comment on lines
+655
to
+659
| temporal cloud nexus endpoint create \ | ||
| --name <my-nexus-endpoint-name> \ | ||
| --target-task-queue my-handler-task-queue \ | ||
| --target-namespace <my-target-namespace.account> \ | ||
| --description-file description.md |
Comment on lines
+63
to
+64
| --namespace-access ns1=admin \ | ||
| --namespace-access ns2=write |
|
|
||
| ```bash | ||
| # replace <your-secret-key> with the "secretKey": output from tcld apikey create command | ||
| # replace <your-secret-key> with the "secretKey": output from the apikey create command |
Comment on lines
+220
to
+223
| temporal cloud namespace capacity update \ | ||
| --namespace <namespace_name> \ | ||
| --capacity-mode <on_demand|provisioned> \ | ||
| --capacity-value <tru_value> |
| @@ -153,6 +187,9 @@ tcld n export gcs g -n test.ns --sink-name test-sink | |||
| } | |||
| ``` | |||
|
|
|||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Next Steps' should use sentence-style capitalization.
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Tag Structure and Limits' should use sentence-style capitalization.
| @@ -97,8 +99,8 @@ Check these setup details before using API keys: | |||
|
|
|||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Global Administrator and Account Owner API key management ************************' should use sentence-style capitalization.
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
cloudClifromprereleasetopublicPreviewinsrc/constants/featureReleaseTypes.js, which updates theReleaseNoteHeaderon/cli/cloudand all 18 cloud command reference pages. Updated the matching prose insetup-cli.mdx.temporal cloudtabs alongside everytcldcommand example across 18 Cloud docs pages, with the Temporal CLI as the default tab.Blocked on two things, hence draft:
setup-cli.mdxstill readstemporalio/prerelease/temporal-cloud. Needs confirmation from the CLI team on whether the tap changes at Public Preview.temporal cloud namespace mtls cert-ca listreplacestcld namespace accepted-client-ca listinlast-connection-error.mdx, but I could not verify the JSON output shape, so the new tab describes reading the expiry rather than reproducing thejq -r '.[0].notAfter'filter.Commands were verified against the generated reference pages in
docs/cli/command-reference/cloud/and cross-checked with local--help. Flag names diverge in several places (--idto--key-id,apikey createtocreate-for-me/create-for-service-account,accepted-client-catomtls cert-ca,set-connectivity-rulestoconnectivity attach/detach).Left tcld-only where the extension has no equivalent:
tcld gen ca/gen leaf(certificates),tcld migration *, andaccount metrics enable/disable.