From 4b0058f1b809c921b0d00df0e4813997313442bf Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Fri, 14 Apr 2023 10:02:17 -0400 Subject: [PATCH] 1.0.0 (#737) * Updating changelog and migration guide to reflect changes from last beta release * Merging 1.0.0 changelog with previous beta releases * Update version links * Updating changelog and migration guide to include changes from #738 --------- Co-authored-by: Will Vedder Co-authored-by: Sergiu Ghitea <28300158+sergiught@users.noreply.github.com> --- CHANGELOG.md | 102 +++++++++++++++++++++++++++++++++++++++------ MIGRATION_GUIDE.md | 13 ++++++ 2 files changed, 102 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3582f0ebd..f910b106f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,22 +7,85 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [1.0.0-beta.3](https://github.com/auth0/auth0-cli/tree/1.0.0-beta.3) (Mar 30, 2023) +## [v1.0.0](https://github.com/auth0/auth0-cli/tree/v1.0.0) (Apr 14, 2023) -Refer to the [v1 migration guide](MIGRATION_GUIDE.md) for instructions on how to navigate breaking changes. +[Full Changelog](https://github.com/auth0/auth0-cli/compare/v0.13.1...v1.0.0) -To try the `v1.0.0-beta.3` release: +:warning: Refer to the [v1 migration guide](MIGRATION_GUIDE.md) for instructions on how to navigate breaking changes. -```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.3" +### Added -# Note: will only download executable in current directory. -# Intentionally omitted from $PATH to avoid collisions with -# stable versions of the CLI. Append to $PATH at own risk. +- 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] +- `perms` alias for `auth0 roles permissions` command [#534] +- Authenticating via client credentials with `auth0 login` [#546] +- Graceful access token regeneration [#547] +- Storing client secret in operating system keyring [#578] +- Supporting additional scopes through `--scopes` flag when authenticating as user [#538] +- Argument to specify log stream type for `auth0 logs streams create` and `auth0 logs streams update` [#599] +- Better guidance on authenticating in the `auth0 login` help text [#565] +- Confirmation prompts before applying editor updates [#603] +- Bespoke messaging when no logs match the provided filter criteria [#733] +- `--users` flag to `auth0 users import` command for providing user JSON payload [#735] +- Warning if updating universal login templates with classic mode enabled [#667] +- Automatic retries with `api` command [#681] +- Clearer device code comparison instructions [#664] +- Storing access token in OS keyring if possible [#645] +- DX improvements to `test login` and `test token` commands [#629] -./auth0 --version # Example execution -``` +### Fixed + +- Return empty JSON array when no results for all list commands and the `--json` flag [#736] +- Unrequiring `--audience` flag in `auth0 test login` [#694] +- Removing duplicate header in `auth0 apis list` output [#711] +- Prevent panic in `auth0 ul templates update` if no branding settings exist [#731] +- Missing table header when using `auth0 logs tail` [#732] +- Empty dashboard urls during `open` commands when authenticated using client credentials [#652] +- `auth0 logs tail` terminating early if no logs found [#672] +- `auth0 apps list` rendering correct number of results in output header [#674] +- `auth0 test token` failing silently with invalid audience input [#671] +- Possible panic when running `auth0 ul update` with empty branding settings (ex: newly-created tenant) [#692] +- Inability to update user password with `auth0 users update --password` [#686] +- Apps shown in multi select when no app-id is passed [#648] +- "something went wrong" error during `auth0 branding texts update` [#584] +- Help text descriptions for most instances of `--number` flag [#610] +- Allow updating a non-existent email template with `auth0 email templates update` [#611] +- `--no-input` flag works for `auth0 test token` and `auth0 test login` commands [#613] +- `--no-color` flag works for all commands [#594] +- All available triggers present when running `auth0 actions create` [#597] +- Extraneous payload property when running `auth0 orgs update` [#583] +- Users search command enables pagination through `--number` flag [#588] +- Tenant commands now respect `--tenant` flag [#612] +- Log tail output now displays absolute time instead of relative [#590] +- Adding missing headers for `auth0 logs list` [#589] +- Output new action data when running `auth0 actions update` [#596] +- Log streams "no roles" errors message [#598] +- Removed erroneous `auth0 apis show --json` truncation message [#607] +- Skip interactive elements when `--json` and `--force` flags are passed [#616] + +### Changed + +- `--format json` flag/value pair consolidated to `--json` [#533] +- Flattened the `auth0 branding` commands into the root-level [#540], [#541] +- Moved `auth0 ips` command to `auth0 ap sit ips` [#618] +- Moved `auth0 users unblock` to `auth0 users blocks unblock` [#617] +- `--reveal` flag for reveal client secret renamed to `--reveal-secrets` [#591] +- More actionable output when executing `auth0 users import` [#735] +- Editorializing code "hints" throughout project [#570] +- Renamed `--connection` flag to `--connection-name` for `auth0 users` commands for consistency [#738] + +### Removed + +- `--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] +- `-u` shortform alias for `--upsert` flag in `auth0 users import` [#735] + +## [v1.0.0-beta.3](https://github.com/auth0/auth0-cli/tree/v1.0.0-beta.3) (Mar 30, 2023) + +[Full Changelog](https://github.com/auth0/auth0-cli/compare/v1.0.0-beta.2...v1.0.0-beta.3) ### Added @@ -40,7 +103,9 @@ curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | s - Possible panic when running `auth0 ul update` with empty branding settings (ex: newly-created tenant) [#692] - Inability to update user password with `auth0 users update --password` [#686] -## [1.0.0-beta.2](https://github.com/auth0/auth0-cli/tree/1.0.0-beta.2) (Feb 14, 2023) +## [v1.0.0-beta.2](https://github.com/auth0/auth0-cli/tree/v1.0.0-beta.2) (Feb 14, 2023) + +[Full Changelog](https://github.com/auth0/auth0-cli/compare/v1.0.0-beta.1...v1.0.0-beta.2) ### Added @@ -51,7 +116,9 @@ curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | s - 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) +## [v1.0.0-beta.1](https://github.com/auth0/auth0-cli/tree/v1.0.0-beta.1) (Jan 20, 2023) + +[Full Changelog](https://github.com/auth0/auth0-cli/compare/v0.13.1...v1.0.0-beta.1) ### Added @@ -102,6 +169,15 @@ curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | s - `auth0 tenants add` command in favor of `auth0 login` [#546] - Updating of action triggers which inevitably results in error [#597] +[unreleased]: https://github.com/auth0/auth0-cli/compare/v1.0.0...HEAD +[#733]: https://github.com/auth0/auth0-cli/issues/733 +[#738]: https://github.com/auth0/auth0-cli/issues/738 +[#735]: https://github.com/auth0/auth0-cli/issues/735 +[#736]: https://github.com/auth0/auth0-cli/issues/736 +[#694]: https://github.com/auth0/auth0-cli/issues/694 +[#711]: https://github.com/auth0/auth0-cli/issues/711 +[#731]: https://github.com/auth0/auth0-cli/issues/731 +[#732]: https://github.com/auth0/auth0-cli/issues/732 [#686]: https://github.com/auth0/auth0-cli/issues/686 [#692]: https://github.com/auth0/auth0-cli/issues/692 [#671]: https://github.com/auth0/auth0-cli/issues/671 diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md index 3d81913f0..d497a1678 100644 --- a/MIGRATION_GUIDE.md +++ b/MIGRATION_GUIDE.md @@ -13,6 +13,7 @@ thoroughly and prepare your potential automated workflows before upgrading to th - [JSON Output Flag](#json-output-flag) - [Reveal Client Secrets Flag](#reveal-client-secrets-flag) - [Config Command Removal](#config-command-removal) +- [Users Import Command](#users-import-command) #### Commands Reorganization @@ -165,3 +166,15 @@ auth0 login --domain travel0.us.auth0.com \ + +#### Users Commands + +The `--connection` flag has been renamed to `--connection-name` for the `auth0 users update`, `auth0 users create` and `auth0 users import` commands for consistency. + +Also notably for the `auth0 users import` command, the `-u` short form alias for the `--upsert` flag in the command has been redesignated to the `--users` flag. + +| **Before (v0)** | **After (v1)** | +| ------------------------------------ | ----------------------------------------------- | +| `auth0 users create --connection` | `auth0 users create --connection-name` | +| `auth0 users update --connection` | `auth0 users update --connection-name` | +| `auth0 users import -u --connection` | `auth0 users import --upsert --connection-name` |