Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog and migration guide for 1.0.0 beta.2 #647

Merged
merged 16 commits into from
Feb 14, 2023
Merged

Update changelog and migration guide for 1.0.0 beta.2 #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
fb73785
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Dec 5, 2022
da6a932
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Dec 5, 2022
0d62b4c
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Dec 6, 2022
a4aed9e
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Dec 9, 2022
fc50ba9
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Jan 5, 2023
054ab9e
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Jan 19, 2023
1aa695c
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Jan 20, 2023
da03c9e
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Jan 20, 2023
358f05c
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Jan 25, 2023
edb118a
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Feb 8, 2023
eaba3cc
Merge branch 'main' of https://github.com/auth0/auth0-cli
willvedd Feb 10, 2023
1772063
Updating changelog for v1.0.0-beta.2
willvedd Feb 13, 2023
9ab3d26
Adding storybook removal point
willvedd Feb 13, 2023
59dd824
Updating migration guide for test command updates
willvedd Feb 13, 2023
717bb9b
Merge branch 'main' into update-changelog-1.0.0-beta.2
willvedd Feb 14, 2023
cf8f86a
Update CHANGELOG.md
sergiught Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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]
Expand Down Expand Up @@ -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
Expand Down
24 changes: 19 additions & 5 deletions MIGRATION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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` |
Expand All @@ -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.


<table>
<tr>
<th>Before (v0)</th>
Expand All @@ -50,6 +50,7 @@ auth0 tenants add travel0.us.auth0.com \
--client-id tUIvAH7g2ykVM4lGriYEQ6BKV3je24Ka \
--client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

</td>
<td>

Expand All @@ -59,16 +60,26 @@ auth0 login --domain travel0.us.auth0.com \
--client-id tUIvAH7g2ykVM4lGriYEQ6BKV3je24Ka \
--client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

</td>
</tr>
</table>

#### `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 <client-id>` |

#### 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
Expand All @@ -94,6 +105,7 @@ auth0 logs streams create \
--datadog-id us \
--datadog-key 3c0c4965368b6b10f8640dbda46abfdc
```

</td>
<td>

Expand All @@ -104,6 +116,7 @@ auth0 logs streams create datadog \
--region us \
--api-key 3c0c4965368b6b10f8640dbda46abfdc
```

</td>
</tr>
</table>
Expand All @@ -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.
Expand All @@ -139,6 +151,7 @@ AUTH0_CLI_CLIENT_ID="tUIvPH7g2ykVm4lGriYEQ6BKV3je24Ka" \
AUTH0_CLI_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
auth0 config init
```

</td>
<td>

Expand All @@ -148,6 +161,7 @@ auth0 login --domain travel0.us.auth0.com \
--client-id tUIvPH7g2ykVm4lGriYEQ6BKV3je24Ka \
--client-secret XXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

</td>
</tr>
</table>