auth0-deploy-cli 2.3.3 → 2.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/.nyc_output/3c262097b440d8cafce3d78c2d2d8c88.json +1 -0
  2. package/.nyc_output/{5a330a0fdb66d1a97d778a4d2ae2cb77.json → ff2a6d329a318dd6c57a9b013e6eafea.json} +0 -0
  3. package/CHANGELOG.md +4 -1
  4. package/config.json +12 -0
  5. package/package.json +2 -3
  6. package/rfc/01-resource-exclusion.md +65 -0
  7. package/.nyc_output/5127c00d0ea4f0511f7cc98e60814456.json +0 -1
package/CHANGELOG.md CHANGED
@@ -4,7 +4,10 @@ All notable changes to this project will be documented in this file.
4
4
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
5
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
6
 
7
- ## [2.3.2] - Unreleased
7
+ ## [2.3.4] - 2022-03-15
8
+ ### Removed
9
+ - `es6-template-strings` dependency that may print political messages
10
+ ## [2.3.2]
8
11
  ### Changed
9
12
  - set `enable_sso` and `sandbox_version` as readonly properties
10
13
  - alias `export = dump` and `import = deploy` for programmatic usage
package/config.json ADDED
@@ -0,0 +1,12 @@
1
+ {
2
+ "AUTH0_DOMAIN": "will-vedder.us.auth0.com",
3
+ "AUTH0_CLIENT_ID": "y53nNoT50WjJBlmYmMg7MSkmM6R8RYcc",
4
+ "AUTH0_CLIENT_SECRET": "bzqmRaIXyv49ATvRyET1huwURhbYN7VP4uMUrhRrVqVQWWDoZ__6GsK5sztiZ_gR",
5
+ "AUTH0_ALLOW_DELETE": false,
6
+ "AUTH0_DEBUG": true,
7
+ "AUTH0_EXPORT_IDENTIFIERS": false,
8
+ "AUTH0_EXCLUDED_RULES": [],
9
+ "AUTH0_EXCLUDED_CONNECTIONS": [],
10
+ "EXCLUDED_PROPS": {},
11
+ "INCLUDED_PROPS": {}
12
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "auth0-deploy-cli",
3
- "version": "2.3.3",
3
+ "version": "2.3.4",
4
4
  "description": "A command line tool for deploying updates to your Auth0 tenant",
5
5
  "main": "lib/index.js",
6
6
  "bin": {
@@ -12,7 +12,7 @@
12
12
  "test": "cross-env NODE_ENV=test nyc mocha --recursive --require babel-register test",
13
13
  "build": "rimraf ./lib && babel src -d lib",
14
14
  "prepare": "npm run build",
15
- "release": "git tag $npm_package_version && git push --tags && npm publish"
15
+ "release": "npm publish --tag v2"
16
16
  },
17
17
  "repository": {
18
18
  "type": "git",
@@ -31,7 +31,6 @@
31
31
  "auth0-extension-tools": "^1.2.1",
32
32
  "auth0-source-control-extension-tools": "^3.2.2",
33
33
  "dot-prop": "^4.2.0",
34
- "es6-template-strings": "^2.0.1",
35
34
  "fs-extra": "^7.0.0",
36
35
  "http-proxy-agent": "^2.0.0",
37
36
  "https-proxy-agent": "^2.0.0",
package/rfc/01-resource-exclusion.md ADDED
@@ -0,0 +1,65 @@
1
+ - Start Date: March 14, 2022
2
+ - RFC PR: https://github.com/auth0/auth0-deploy-cli/pull/<PR_NUMBER>
3
+
4
+ # Summary
5
+
6
+ In this RFC, we propose a mechanism for excluding entire resources from the management purview of Deploy CLI.
7
+
8
+ Resource exclusion is an often requested feature from the community and has many legitimate use-cases. Currently, there is some resource-specific exclusion functionality, on a per-ID basis, but nothing that excludes entire resource types.
9
+
10
+
11
+ ## Why Exclude?
12
+
13
+ ## Existing Methods of Exclusion
14
+
15
+ The following are existing configuration values for excluding resources on a per-ID basis:
16
+
17
+ - `AUTH0_EXCLUDED_RULES`
18
+ - `AUTH0_EXCLUDED_CLIENTS`
19
+ - `AUTH0_EXCLUDED_DATABASES`
20
+ - `AUTH0_EXCLUDED_CONNECTIONS`
21
+ - `AUTH0_EXCLUDED_RESOURCE_SERVERS`
22
+
23
+ There are two problems these configurations though:
24
+
25
+ 1. They only apply on a per-ID basis, meaning that there is no way to automatically exclude all of that certain resource. This is a minor inconvenience for a handful of a certain resource, however, in the case of hundreds or thousands of a certain resource, it becomes untenable.
26
+
27
+ Further, as more of a certain resource gets added, they'll necessarily need to be added to the Deploy CLI configuration, requiring more touch points.
28
+
29
+ 2. This only covers a subset of all resources. The Auth0 Management API is still expanding in scope,
30
+
31
+ Granted, it is possible to accommodate all n number of resource types with n number of exclusion properties, but can become unmanageable
32
+
33
+
34
+ ### Deprecation
35
+
36
+ The intention is to **eventually deprecate** these bespoke configurations.
37
+
38
+ # Proposed Solution
39
+
40
+ The proposed solution is to introduce an array
41
+
42
+ An example `config.json` file:
43
+
44
+ ```json
45
+ {
46
+ "AUTH0_DOMAIN": "<DOMAIN>",
47
+ "AUTH0_CLIENT_ID": "<CLIENT_ID>",
48
+ "AUTH0_CLIENT_SECRET": "<CLIENT_SECRET",
49
+ "AUTH0_ALLOW_DELETE": false,
50
+ "AUTH0_EXCLUDED": [
51
+ "connections",
52
+ "rules",
53
+ "actions",
54
+ ]
55
+ }
56
+ ```
57
+
58
+ ## Relevant Github Issues
59
+
60
+ - [Provide a way to exclude all of an object during a0deploy import · Issue #375](https://github.com/auth0/auth0-deploy-cli/issues/375)
61
+ - [Add config to exclude Actions - AUTH0_EXCLUDED_ACTIONS · Issue #397](https://github.com/auth0/auth0-deploy-cli/issues/397)
62
+ - [Ability to exclude objects when import/export using deploy-cli · Issue #394](https://github.com/auth0/auth0-deploy-cli/issues/394)
63
+ - [Allow skipping export of Organizations · Issue #427](https://github.com/auth0/auth0-deploy-cli/issues/427)
64
+
65
+