@automatify-au/cli 0.1.5 → 0.1.7

package/README.md

@@ -19,6 +19,7 @@ Command-group note:
 - No separate backend.
 - No duplicate domain/business logic in CLI.
 - CLI commands must call shared Forge contracts (resolver/webtrigger paths) as they are introduced.
+- Focused evidence commands may call Jira Cloud REST APIs directly when the feature is specifically Jira-native attachment/comment work.
 
 ## MVP non-goals
 - No separate backend.
@@ -76,6 +77,16 @@ Minimum:
 - `TESTOPS_FORGE_ENDPOINT` for commands that call Forge contracts (`doctor`, `ingest`, `run`, `sync`)
 - `TESTOPS_FORGE_AUTH_TOKEN` from the one-time token shown in Forge `Operations -> CLI access`
 
+Local config helper:
+```bash
+automatify testops config set baseUrl https://automatify-com-au.atlassian.net
+automatify testops config set projectKey DEV
+automatify testops config set forgeEndpoint "<webtrigger-url>"
+printf "%s" "$TESTOPS_FORGE_AUTH_TOKEN" | automatify testops config set forgeAuthToken --stdin
+```
+
+`forgeAuthToken` local storage currently uses macOS Keychain. On Windows, Linux, and CI, keep the token in `TESTOPS_FORGE_AUTH_TOKEN` instead. `.testops-cli.json` should store non-secret values only.
+
 Optional:
 - `TESTOPS_FORGE_TIMEOUT_MS`
 - `TESTOPS_FORGE_MAX_RETRIES`
@@ -91,6 +102,7 @@ All TestOps commands are invoked as `automatify testops <command>`:
 - `bdd`
   - `automatify testops bdd scenarios show --id <SCENARIO_ID>`
   - `automatify testops bdd scenarios show --id <SCENARIO_ID> --format feature`
+  - `automatify testops bdd scenarios show --id <SCENARIO_ID|SC-4> --feature`
   - `automatify testops bdd scenarios export --id <SCENARIO_ID|SC-4> --output-dir ./scenario-export`
   - `automatify testops bdd scenarios export --all --output-dir ./scenario-export`
   - `automatify testops bdd scenarios import --file ./scenario-export/SC-4.feature`
@@ -127,10 +139,55 @@ All TestOps commands are invoked as `automatify testops <command>`:
   - `automatify testops ingest feature --file <path>` or `--stdin`
 - `run`
   - `automatify testops run upload --file <path>` or `--stdin`
+- `allure`
+  - `automatify testops allure upload ABC-123 ./allure-report.zip --dry-run`
+  - `automatify testops allure upload ABC-123 ./allure-report.zip`
 - `auto`
   - `automatify testops auto --dry-run`
   - `automatify testops auto`
 
+## Allure Evidence for Jira
+
+Purpose:
+- upload an already generated Allure HTML report ZIP to a Jira issue as evidence.
+- parse `widgets/summary.json` from the ZIP and add a concise Jira comment with result counts.
+- keep the flow Java-free and backend-free; this command does not generate Allure reports from raw `allure-results`.
+
+Supported ZIP layouts:
+- `widgets/summary.json`
+- `allure-report/widgets/summary.json`
+- any nested path ending in `/widgets/summary.json`
+
+Credentials:
+```bash
+export JIRA_SITE="https://example.atlassian.net"
+export JIRA_EMAIL="qa@example.com"
+export JIRA_API_TOKEN="<atlassian-api-token>"
+```
+
+`JIRA_BASE_URL` and existing `.testops-cli.json` `baseUrl` are also accepted for the site URL. CLI flags take precedence:
+```bash
+automatify testops allure upload ABC-123 ./allure-report.zip \
+  --site https://example.atlassian.net \
+  --email qa@example.com \
+  --api-token "$JIRA_API_TOKEN"
+```
+
+Dry run:
+```bash
+automatify testops allure upload ABC-123 ./allure-report.zip --dry-run
+```
+
+Upload without a Jira comment:
+```bash
+automatify testops allure upload ABC-123 ./allure-report.zip --no-comment
+```
+
+Machine-readable output:
+```bash
+automatify testops allure upload ABC-123 ./allure-report.zip --dry-run --json
+```
+
 ### Optional gated maintenance commands
 
 - `sync`
@@ -171,6 +228,19 @@ export JIRA_BASE_URL="https://automatify-com-au.atlassian.net"
 export JIRA_PROJECT_KEY="DEV"
 ```
 
+Or store the non-secret values in `.testops-cli.json` and, on macOS, the token in Keychain:
+```bash
+automatify testops config set baseUrl https://automatify-com-au.atlassian.net
+automatify testops config set projectKey DEV
+automatify testops config set forgeEndpoint "<webtrigger-url>"
+printf "%s" "$TESTOPS_FORGE_AUTH_TOKEN" | automatify testops config set forgeAuthToken --stdin
+```
+
+Windows, Linux, and CI should keep the token in environment variables:
+```bash
+export TESTOPS_FORGE_AUTH_TOKEN="<one-time-token-from-forge-ui>"
+```
+
 Transport notes:
 - Bearer auth is required for operator/CI use. Forge stores only the token hash plus metadata.
 - Tokens are project-scoped, shown once at creation time, and can be revoked from the Forge UI.
@@ -317,7 +387,7 @@ automatify testops ingest feature --project-key DEV --file ./artifacts/features-
 ```
 
 Feature export notes:
-- `bdd scenarios show --format feature` renders one scenario in feature-style text.
+- `bdd scenarios show --format feature` and `bdd scenarios show --feature` render one scenario in feature-style text.
 - `bdd scenarios export` writes a single-scenario `SC-*.feature` file with a reserved `@testops-scenario-SC-*` tag.
 - Jira issue links are exported as normal Gherkin tags like `@DEV-2`; on import they are written back to `linkedIssueKeys`.
 - current model has `linked issues`, not a separate persisted `primary issue`, so all exported issue-key tags are treated as equal links.