From e6a7dd561c0185a4e4fc38314b94568221dc786e Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Tue, 14 Feb 2023 10:23:32 -0500 Subject: [PATCH] Update changelog and migration guide for 1.0.0 beta.2 (#647) * Updating changelog for v1.0.0-beta.2 * Adding storybook removal point * Updating migration guide for test command updates * Update CHANGELOG.md --------- Co-authored-by: Will Vedder Co-authored-by: Sergiu Ghitea <28300158+sergiught@users.noreply.github.com> --- CHANGELOG.md | 22 +++++++++++++++++++--- MIGRATION_GUIDE.md | 24 +++++++++++++++++++----- 2 files changed, 38 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 004b9b06c..1602dd34b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,15 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [1.0.0-beta.1](https://github.com/auth0/auth0-cli/tree/1.0.0-beta.1) (Jan 20, 2023) +## [1.0.0-beta.2](https://github.com/auth0/auth0-cli/tree/1.0.0-beta.2) (Feb 14, 2023) Refer to the [v1 migration guide](MIGRATION_GUIDE.md) for instructions on how to navigate breaking changes. -To try the `v1.0.0-beta.1` release: +To try the `v1.0.0-beta.2` release: ```bash # Binary will be downloaded to "./auth0". -curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b . "v1.0.0-beta.1" +curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b . "v1.0.0-beta.2" # Note: will only download executable in current directory. # Intentionally omitted from $PATH to avoid collisions with @@ -26,6 +26,17 @@ curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | s ### Added +- Storing access token in OS keyring if possible [#645] +- DX improvements to `test login` and `test token` commands [#629] + +### Fixed + +- Apps shown in multi select when no app-id is passed [#648] + +## [1.0.0-beta.1](https://github.com/auth0/auth0-cli/tree/1.0.0-beta.1) (Jan 20, 2023) + +### Added + - Ability to view user's assigned roles via `auth0 users roles show` [#604] - Assign role(s) to user via `auth0 users roles assign` [#605] - Remove user role(s) via `auth0 users roles remove` [#606] @@ -67,11 +78,16 @@ curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | s ### Removed +- Storybook preview when updating universal login templates [#592] - `--force` and `--json` flags relegated from global context, now applied only where appropriate [#536], [#595] - Undocumented `auth0 config init` command [#532] - `auth0 tenants add` command in favor of `auth0 login` [#546] - Updating of action triggers which inevitably results in error [#597] +[#648]: https://github.com/auth0/auth0-cli/issues/648 +[#645]: https://github.com/auth0/auth0-cli/issues/645 +[#629]: https://github.com/auth0/auth0-cli/issues/629 +[#592]: https://github.com/auth0/auth0-cli/issues/592 [#604]: https://github.com/auth0/auth0-cli/issues/604 [#605]: https://github.com/auth0/auth0-cli/issues/605 [#606]: https://github.com/auth0/auth0-cli/issues/606 diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md index d6c0ebc21..3d81913f0 100644 --- a/MIGRATION_GUIDE.md +++ b/MIGRATION_GUIDE.md @@ -9,6 +9,7 @@ thoroughly and prepare your potential automated workflows before upgrading to th - [Commands Reorganization](#commands-reorganization) - [Authenticating With Client Credentials](#authenticating-with-client-credentials) +- [`test` Commands](#test-commands) - [JSON Output Flag](#json-output-flag) - [Reveal Client Secrets Flag](#reveal-client-secrets-flag) - [Config Command Removal](#config-command-removal) @@ -19,7 +20,7 @@ Some commands have been reorganized to establish a more systematic hierarchy. All other facets of the commands (arguments, flags, etc.) remain the same. | **Before (v0)** | **After (v1)** | -|----------------------------|-------------------------------------------------| +| -------------------------- | ----------------------------------------------- | | `auth0 ips` | `auth0 protection suspicious-ip-throttling ips` | | `auth0 users unblock` | `auth0 users blocks unblock` | | `auth0 branding domains` | `auth0 domains` | @@ -35,7 +36,6 @@ The `auth0 tenants add` command which enabled authenticating to a tenant via cli into the `auth0 login` command. It can be interfaced interactively through the terminal or non-interactively by passing in the client credentials through the flags. - @@ -50,6 +50,7 @@ auth0 tenants add travel0.us.auth0.com \ --client-id tUIvAH7g2ykVM4lGriYEQ6BKV3je24Ka \ --client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` +
Before (v0) @@ -59,16 +60,26 @@ auth0 login --domain travel0.us.auth0.com \ --client-id tUIvAH7g2ykVM4lGriYEQ6BKV3je24Ka \ --client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` +
+#### `test` Commands + +The `auth0 test token` and `auth0 test login` commands have been adjusted to facilitate a better developer experience. Specifically, the `--connection` flag has been renamed to `--connection-name` for clarity, the `--client-id` flag changed into an argument. Also noteworthy is that a test application is no longer created by default when running `auth0 test token` without a provided client but still presented as an option. + +| **Before (v0)** | **After (v1)** | +| ------------------------------- | ------------------------------------ | +| `auth0 test login --connection` | `auth0 test login --connection-name` | +| `auth0 test token --client-id` | `auth0 test token ` | + #### JSON Output Flag The `--format json` flag-value pair has been condensed into the `--json` flag. | **Before (v0)** | **After (v1)** | -|---------------------------------|--------------------------| +| ------------------------------- | ------------------------ | | `auth0 apps list --format json` | `auth0 apps list --json` | #### Log Streams @@ -94,6 +105,7 @@ auth0 logs streams create \ --datadog-id us \ --datadog-key 3c0c4965368b6b10f8640dbda46abfdc ``` + @@ -104,6 +116,7 @@ auth0 logs streams create datadog \ --region us \ --api-key 3c0c4965368b6b10f8640dbda46abfdc ``` + @@ -114,10 +127,9 @@ In `v0.x`, the `auth0 apps create` command has a `--reveal` flag that would reve This flag has changed to `--reveal-secrets` to clarify what is being revealed. | **Before (v0)** | **After (v1)** | -|------------------------------|--------------------------------------| +| ---------------------------- | ------------------------------------ | | `auth0 apps create --reveal` | `auth0 apps create --reveal-secrets` | - #### Config Command Removal In `v0.x`, the undocumented `auth0 config init` command existed to authenticate with a tenant for E2E testing. @@ -139,6 +151,7 @@ AUTH0_CLI_CLIENT_ID="tUIvPH7g2ykVm4lGriYEQ6BKV3je24Ka" \ AUTH0_CLI_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXXXXX" \ auth0 config init ``` + @@ -148,6 +161,7 @@ auth0 login --domain travel0.us.auth0.com \ --client-id tUIvPH7g2ykVm4lGriYEQ6BKV3je24Ka \ --client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` +