From 040f4e2fc9ab5bc68344f992b547f1b0bae58a12 Mon Sep 17 00:00:00 2001 From: Charles Zhao Date: Wed, 4 Sep 2024 19:07:49 +0800 Subject: [PATCH] release(tunnel): version 0.2.0 --- .changeset/modern-ghosts-sin.md | 41 -------------------------------- packages/tunnel/CHANGELOG.md | 42 +++++++++++++++++++++++++++++++++ packages/tunnel/package.json | 2 +- 3 files changed, 43 insertions(+), 42 deletions(-) delete mode 100644 .changeset/modern-ghosts-sin.md diff --git a/.changeset/modern-ghosts-sin.md b/.changeset/modern-ghosts-sin.md deleted file mode 100644 index ed70fa7b675c..000000000000 --- a/.changeset/modern-ghosts-sin.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -"@logto/tunnel": minor ---- - -add deploy command and env support - -#### Add new `deploy` command to deploy your local custom UI assets to your Logto Cloud tenant - -1. Create a machine-to-machine app with Management API permissions in your Logto tenant. -2. Run the following command: - -```bash -npx @logto/tunnel deploy --auth : --endpoint https://.logto.app --management-api-resource https://.logto.app/api --experience-path /path/to/your/custom/ui -``` - -Note: -1. The `--management-api-resource` (or `--resource`) can be omitted when using the default Logto domain, since the CLI can infer the value automatically. If you are using custom domain for your Logto endpoint, this option must be provided. -2. You can also specify an existing zip file (`--zip-path` or `--zip`) instead of a directory to deploy. Only one of `--experience-path` or `--zip-path` can be used at a time. - -```bash -npx @logto/tunnel deploy --auth : --endpoint https://.logto.app --zip-path /path/to/your/custom/ui.zip -``` - -#### Add environment variable support - -1. Create a `.env` file in the CLI root directory, or any parent directory where the CLI is located. -2. Alternatively, specify environment variables directly when running CLI commands: - -```bash -LOGTO_ENDPOINT=https://.logto.app npx @logto/tunnel ... -``` - -Supported environment variables: - -- LOGTO_AUTH -- LOGTO_ENDPOINT -- LOGTO_EXPERIENCE_PATH (or LOGTO_PATH) -- LOGTO_EXPERIENCE_URI (or LOGTO_URI) -- LOGTO_MANAGEMENT_API_RESOURCE (or LOGTO_RESOURCE) -- LOGTO_ZIP_PATH (or LOGTO_ZIP) -``` diff --git a/packages/tunnel/CHANGELOG.md b/packages/tunnel/CHANGELOG.md index d53d13766b2a..d53f145b610f 100644 --- a/packages/tunnel/CHANGELOG.md +++ b/packages/tunnel/CHANGELOG.md @@ -1,5 +1,47 @@ # @logto/tunnel +## @logto/tunnel@0.2.0 + +### Minor Changes + +- ff4cd67a9: add deploy command and env support + + #### Add new `deploy` command to deploy your local custom UI assets to your Logto Cloud tenant + + 1. Create a machine-to-machine app with Management API permissions in your Logto tenant. + 2. Run the following command: + + ```bash + npx @logto/tunnel deploy --auth : --endpoint https://.logto.app --management-api-resource https://.logto.app/api --experience-path /path/to/your/custom/ui + ``` + + Note: + + 1. The `--management-api-resource` (or `--resource`) can be omitted when using the default Logto domain, since the CLI can infer the value automatically. If you are using custom domain for your Logto endpoint, this option must be provided. + 2. You can also specify an existing zip file (`--zip-path` or `--zip`) instead of a directory to deploy. Only one of `--experience-path` or `--zip-path` can be used at a time. + + ```bash + npx @logto/tunnel deploy --auth : --endpoint https://.logto.app --zip-path /path/to/your/custom/ui.zip + ``` + + #### Add environment variable support + + 1. Create a `.env` file in the CLI root directory, or any parent directory where the CLI is located. + 2. Alternatively, specify environment variables directly when running CLI commands: + + ```bash + LOGTO_ENDPOINT=https://.logto.app npx @logto/tunnel ... + ``` + + Supported environment variables: + + - LOGTO_AUTH + - LOGTO_ENDPOINT + - LOGTO_EXPERIENCE_PATH (or LOGTO_PATH) + - LOGTO_EXPERIENCE_URI (or LOGTO_URI) + - LOGTO_MANAGEMENT_API_RESOURCE (or LOGTO_RESOURCE) + - LOGTO_ZIP_PATH (or LOGTO_ZIP) + ## 0.1.0 ### Minor Changes diff --git a/packages/tunnel/package.json b/packages/tunnel/package.json index ee4ce44eb245..89f27308211e 100644 --- a/packages/tunnel/package.json +++ b/packages/tunnel/package.json @@ -1,6 +1,6 @@ { "name": "@logto/tunnel", - "version": "0.1.0", + "version": "0.2.0", "description": "A CLI tool that creates tunnel service to Logto Cloud for local development.", "author": "Silverhand Inc. ", "homepage": "https://github.com/logto-io/logto#readme",