@automatify-au/cli 0.1.6 → 0.1.7

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 (3) hide show
  1. package/README.md +46 -0
  2. package/dist/automatify.cjs +10441 -287
  3. package/package.json +3 -1
package/README.md CHANGED
@@ -19,6 +19,7 @@ Command-group note:
19
19
  - No separate backend.
20
20
  - No duplicate domain/business logic in CLI.
21
21
  - CLI commands must call shared Forge contracts (resolver/webtrigger paths) as they are introduced.
22
+ - Focused evidence commands may call Jira Cloud REST APIs directly when the feature is specifically Jira-native attachment/comment work.
22
23
 
23
24
  ## MVP non-goals
24
25
  - No separate backend.
@@ -138,10 +139,55 @@ All TestOps commands are invoked as `automatify testops <command>`:
138
139
  - `automatify testops ingest feature --file <path>` or `--stdin`
139
140
  - `run`
140
141
  - `automatify testops run upload --file <path>` or `--stdin`
142
+ - `allure`
143
+ - `automatify testops allure upload ABC-123 ./allure-report.zip --dry-run`
144
+ - `automatify testops allure upload ABC-123 ./allure-report.zip`
141
145
  - `auto`
142
146
  - `automatify testops auto --dry-run`
143
147
  - `automatify testops auto`
144
148
 
149
+ ## Allure Evidence for Jira
150
+
151
+ Purpose:
152
+ - upload an already generated Allure HTML report ZIP to a Jira issue as evidence.
153
+ - parse `widgets/summary.json` from the ZIP and add a concise Jira comment with result counts.
154
+ - keep the flow Java-free and backend-free; this command does not generate Allure reports from raw `allure-results`.
155
+
156
+ Supported ZIP layouts:
157
+ - `widgets/summary.json`
158
+ - `allure-report/widgets/summary.json`
159
+ - any nested path ending in `/widgets/summary.json`
160
+
161
+ Credentials:
162
+ ```bash
163
+ export JIRA_SITE="https://example.atlassian.net"
164
+ export JIRA_EMAIL="qa@example.com"
165
+ export JIRA_API_TOKEN="<atlassian-api-token>"
166
+ ```
167
+
168
+ `JIRA_BASE_URL` and existing `.testops-cli.json` `baseUrl` are also accepted for the site URL. CLI flags take precedence:
169
+ ```bash
170
+ automatify testops allure upload ABC-123 ./allure-report.zip \
171
+ --site https://example.atlassian.net \
172
+ --email qa@example.com \
173
+ --api-token "$JIRA_API_TOKEN"
174
+ ```
175
+
176
+ Dry run:
177
+ ```bash
178
+ automatify testops allure upload ABC-123 ./allure-report.zip --dry-run
179
+ ```
180
+
181
+ Upload without a Jira comment:
182
+ ```bash
183
+ automatify testops allure upload ABC-123 ./allure-report.zip --no-comment
184
+ ```
185
+
186
+ Machine-readable output:
187
+ ```bash
188
+ automatify testops allure upload ABC-123 ./allure-report.zip --dry-run --json
189
+ ```
190
+
145
191
  ### Optional gated maintenance commands
146
192
 
147
193
  - `sync`