dry-run - GA

feat: enhance dry-run functionality and documentation

feat: enhance dry-run functionality and documentation

feat: enhance dry-run functionality and documentation

feat: enhance dry-run functionality for tenant assets

feat: enhance dry-run functionality and tests

feat: improve precision in hoursToMinutes function

- src/sessionDurationsToMinutes.ts: update return value to include 4 decimal places

feat: update dependencies in package.json
- package.json: upgrade @clack/prompts to 1.1.0
- package.json: upgrade chalk to 5.6.2
- package.json: add @types/chai to devDependencies

feat: enhance dry-run functionality in userAttributeProfiles handler and tests
- src/tools/auth0/handlers/default.ts: add 'riskAssessment' type to settings
- src/tools/auth0/handlers/userAttributeProfiles.ts: implement dry run check for changes
- test/tools/auth0/handlers/userAttributeProfiles.tests.js: add test for dry run short-circuit behavior

feat: enhance dry-run functionality and tests

feat: enhance dry-run functionality and tests
- src/tools/calculateChanges.ts: add normalizeArrayValues function to handle array normalization
- src/tools/calculateChanges.ts: update getObjectDifferences to use normalized arrays for comparison
- test/tools/calculateChanges.test.ts: add tests to validate dry-run comparisons ignoring array order
- test/tools/calculateChanges.test.ts: add tests for real differences after normalizing array order

feat: enhance dry-run functionality and tests
- src/tools/calculateChanges.ts: add normalizeArrayValues function to handle array normalization
- src/tools/calculateChanges.ts: update getObjectDifferences to use normalized arrays for comparison
- test/tools/calculateChanges.test.ts: add tests to validate dry-run comparisons ignoring array order
- test/tools/calculateChanges.test.ts: add tests for real differences after normalizing array order

fix(src/tools/calculateChanges.ts): update regex for array path matching to improve log clarity

refactor: add dry-run change calculation utilities

feat: Enhance APIHandler and Auth0 logging

Author: kushalshit27

.gitignore

@@ -22,3 +22,4 @@ CLAUDE.md
 .github/agents/*
 .github/skills/*
 package-lock.json
+.github/hooks/*

docs/using-dry-run.md

@@ -8,16 +8,16 @@ The Auth0 Deploy CLI supports a "dry run" mode that allows you to preview all po
 
 ### Command Line Interface
 
-Add the `--dry_run` flag to your import command:
+Add the `--dry-run` flag to your import command:
 
 ```bash
-a0deploy import --config_file=config.json --input_file=./tenant.yaml --dry_run
+a0deploy import --config_file=config.json --input_file=./tenant.yaml --dry-run
 ```
 
 Or use the shorter form:
 
 ```bash
-a0deploy import -c config.json -i ./tenant-directory --dry_run
+a0deploy import -c config.json -i ./tenant-directory --dry-run
 ```
 
 ### Node Module
@@ -44,7 +44,9 @@ deploy({
   });
 ```
 
-**Note**: Using `AUTH0_DRY_RUN` will present an interactive prompt to select options after displaying the dry run preview.
+**Note**: To get the interactive menu when using the Node module, also set `AUTH0_DRY_RUN_INTERACTIVE: true`.
+
+To show the preview and then apply without prompting when using the Node module, set `AUTH0_DRY_RUN_APPLY: true` alongside `AUTH0_DRY_RUN: true`.
 
 ### Environment Variable
 
@@ -55,6 +57,41 @@ export AUTH0_DRY_RUN=true
 a0deploy import -c config.json -i ./tenant.yaml
 ```
 
+## CI/CD Usage
+
+By default, `--dry-run` is non-interactive and safe for CI pipelines.
+
+### Preview Only
+
+Shows the plan and exits without applying changes:
+
+```bash
+a0deploy import -c config.json -i tenant.yaml --dry-run
+```
+
+GitHub Actions:
+
+```yaml
+- name: Preview Auth0 changes
+  run: a0deploy import -c config.json -i tenant.yaml --dry-run
+```
+
+### Deployment with Visibility
+
+Show the plan and apply without prompting:
+
+```bash
+a0deploy import -c config.json -i tenant.yaml --dry-run --apply
+```
+
+### Interactive Review (Manual Deployments)
+
+Add `--interactive` to get the menu (apply / export to file / exit):
+
+```bash
+a0deploy import -c config.json -i tenant.yaml --dry-run --interactive
+```
+
 ## Understanding the Output
 
 Dry run mode provides a detailed preview of all proposed changes in a table format:
@@ -67,14 +104,16 @@ Input: local/tenant.yaml
 
 Simulating deployment... The following changes are proposed:
 
-| Resource      | Status  | Name / Identifier                |
-|---------------|---------|----------------------------------|
-| Actions       | CREATE  | Post-Login User Enrichment       |
-|               | CREATE  | Pre-Registration Validation      |
-|               | DELETE* | Deprecated Action                |
-| Clients       | CREATE  | New SPA Application              |
-|               | UPDATE  | Existing M2M Application         |
-| Connections   | UPDATE  | Username-Password-Authentication |
+┌─────────────┬─────────┬──────────────────────────────────┐
+│ Resource    │ Status  │ Name / Identifier                │
+├─────────────┼─────────┼──────────────────────────────────┤
+│ Actions     │ CREATE  │ Post-Login User Enrichment       │
+│             │ CREATE  │ Pre-Registration Validation      │
+│             │ DELETE* │ Deprecated Action                │
+│ Clients     │ CREATE  │ New SPA Application              │
+│             │ UPDATE  │ Existing M2M Application         │
+│ Connections │ UPDATE  │ Username-Password-Authentication │
+└─────────────┴─────────┴──────────────────────────────────┘
 
 * Requires AUTH0_ALLOW_DELETE to be enabled
 
@@ -104,7 +143,7 @@ When `AUTH0_ALLOW_DELETE` is enabled, dry run will show which resources would be
 ```bash
 # Enable deletions in your config
 export AUTH0_ALLOW_DELETE=true
-a0deploy import -c config.json -i ./tenant.yaml --dry_run
+a0deploy import -c config.json -i ./tenant.yaml --dry-run
 ```
 
 Resources marked for deletion will appear in the output with `DELETE*` status, and the asterisk note will explain that `AUTH0_ALLOW_DELETE` must be enabled for deletions to occur.

dry-run-ga-plan.md

@@ -32,9 +32,10 @@
   "readme": "README.md",
   "homepage": "https://github.com/auth0/auth0-deploy-cli#readme",
   "dependencies": {
-    "@clack/prompts": "0.11.0",
+    "@clack/prompts": "1.1.0",
     "ajv": "^6.12.6",
     "auth0": "^5.4.0",
+    "chalk": "5.6.2",
     "dot-prop": "^5.3.0",
     "fs-extra": "^10.1.0",
     "js-yaml": "^4.1.1",
@@ -49,6 +50,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
+    "@types/chai": "^5.2.3",
     "@types/fs-extra": "^9.0.13",
     "@types/lodash": "^4.17.24",
     "@types/mocha": "^10.0.10",