@automatify-au/cli 0.1.9 → 0.1.11

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.
package/README.md CHANGED
@@ -120,6 +120,12 @@ All TestOps commands are invoked as `automatify testops <command>`:
120
120
  - `doctor`
121
121
  - `automatify testops doctor check`
122
122
  - `automatify testops doctor check --json`
123
+ - `allure`
124
+ - `automatify allure doctor`
125
+ - `automatify allure doctor --json`
126
+ - `automatify allure doctor --issue-key ABC-123`
127
+ - `automatify allure open ./allure-report.zip`
128
+ - `automatify allure open ./allure-report.zip --no-open --port 8080`
123
129
 
124
130
  ### Advanced browse commands
125
131
 
@@ -142,6 +148,8 @@ All TestOps commands are invoked as `automatify testops <command>`:
142
148
  - `allure`
143
149
  - `automatify testops allure upload ABC-123 ./allure-report.zip --dry-run`
144
150
  - `automatify testops allure upload ABC-123 ./allure-report.zip`
151
+ - `automatify testops allure download ABC-123 --output-dir ./downloads`
152
+ - `automatify testops allure open ./allure-report.zip`
145
153
  - `auto`
146
154
  - `automatify testops auto --dry-run`
147
155
  - `automatify testops auto`
@@ -150,6 +158,7 @@ All TestOps commands are invoked as `automatify testops <command>`:
150
158
 
151
159
  Purpose:
152
160
  - upload an already generated Allure HTML report ZIP to a Jira issue as evidence.
161
+ - download an uploaded Allure HTML report ZIP from a Jira issue for local inspection.
153
162
  - parse `widgets/summary.json` from the ZIP and add a concise Jira comment with result counts.
154
163
  - keep the flow Java-free and backend-free; this command does not generate Allure reports from raw `allure-results`.
155
164
 
@@ -216,6 +225,59 @@ After a real upload, JSON output includes Jira attachment metadata when Jira ret
216
225
  }
217
226
  ```
218
227
 
228
+ Download the latest Allure report ZIP attachment from a Jira issue:
229
+ ```bash
230
+ automatify testops allure download ABC-123 --output-dir ./downloads
231
+ ```
232
+
233
+ Download selection rules:
234
+ - `--attachment-id <id>` downloads one exact Jira attachment.
235
+ - `--filename <name>` downloads the newest attachment with that filename.
236
+ - without either flag, the CLI chooses the newest `allure-report*.zip` attachment, then falls back to the newest `.zip` attachment.
237
+ - existing local files are not overwritten unless `--force` is passed.
238
+
239
+ Download dry run / JSON:
240
+ ```bash
241
+ automatify testops allure download ABC-123 --dry-run --json
242
+ ```
243
+
244
+ Allure preflight:
245
+ ```bash
246
+ automatify allure doctor
247
+ ```
248
+
249
+ `automatify allure doctor` checks:
250
+ - Jira site/email/API token resolution for direct Allure upload/download.
251
+ - optional Jira issue access only when `--issue-key` is passed.
252
+ - `unzip` availability for manual local ZIP inspection.
253
+ - Java availability as a warning-only optional check for future raw `allure-results` workflows.
254
+ - Allure CLI availability as a warning-only optional check.
255
+
256
+ Generated Allure HTML ZIP upload/download/open does not require Java or the Allure CLI.
257
+
258
+ Optional live Jira issue check:
259
+ ```bash
260
+ automatify allure doctor --issue-key ABC-123
261
+ ```
262
+
263
+ ### Open a generated Allure HTML report locally
264
+
265
+ ```bash
266
+ automatify allure open ./allure-report.zip
267
+ ```
268
+
269
+ `automatify allure open <zipPath>` and `automatify testops allure open <zipPath>` extract the report into a temporary directory, start a Java-free Node static HTTP server on an ephemeral port, and open the URL in your default browser. This is useful after downloading an Allure ZIP from Jira.
270
+
271
+ Options:
272
+ - `--port <n>` fixed port (default `0` for an OS-assigned free port).
273
+ - `--host <h>` bind host (default `127.0.0.1`).
274
+ - `--extract-to <dir>` extract into a chosen directory; the directory is preserved on shutdown.
275
+ - `--keep` preserves the auto-created temp extract directory on shutdown.
276
+ - `--no-open` skips browser launch for CI/headless checks.
277
+ - `--json`, `--dry-run`, `--verbose`.
278
+
279
+ The server stays alive until Ctrl+C / `SIGTERM`. URL path traversal and malformed paths are rejected.
280
+
219
281
  ### Optional gated maintenance commands
220
282
 
221
283
  - `sync`
@@ -369,6 +431,7 @@ automatify testops bdd features export --project-key DEV --output-dir ./artifact
369
431
  automatify testops runs show --project-key DEV --id <RUN_ID> --json
370
432
  automatify testops config validate
371
433
  automatify testops doctor check --json
434
+ automatify allure doctor --json
372
435
  ```
373
436
 
374
437
  Advanced browse examples: