@allurereport/ci 3.22.0 → 3.22.1
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 +17 -0
- package/dist/reportMarkdown.js +7 -0
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -9,3 +9,20 @@
|
|
|
9
9
|
- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
|
|
10
10
|
|
|
11
11
|
---
|
|
12
|
+
|
|
13
|
+
## Publication outcomes in report summaries
|
|
14
|
+
|
|
15
|
+
Plugin summaries have an optional `published` boolean. `true` means the requested publication
|
|
16
|
+
completed; `false` means publication was requested but did not complete. The field is omitted
|
|
17
|
+
when publication was not requested, including realtime runs. Dump-only runs generate no summaries.
|
|
18
|
+
Plugins without a summary are outside this publication status contract.
|
|
19
|
+
|
|
20
|
+
The remote batch is confirmed only after completion. If uploading or completing the batch fails,
|
|
21
|
+
all reports in that batch are marked unpublished even if some files were already uploaded.
|
|
22
|
+
A successful publication does not require a returned report link.
|
|
23
|
+
|
|
24
|
+
`createReportContext` reads the flag from `summary.json`; `createReportContextFromData` accepts it
|
|
25
|
+
in `summaries`. `renderReportSummaryMarkdown` includes an **Expected reports were not published**
|
|
26
|
+
warning after the statistics table for reports with `published: false`. Older summaries without
|
|
27
|
+
the field retain the existing output. Details remain in the CLI logs; publication warnings do not
|
|
28
|
+
change test statistics, quality gates, or the run's exit code.
|
package/dist/reportMarkdown.js
CHANGED
|
@@ -223,6 +223,12 @@ const renderArtifacts = (artifacts) => {
|
|
|
223
223
|
});
|
|
224
224
|
return [`<details>`, `<summary>Artifacts used (${artifacts.length})</summary>`, "", ...rows, "", "</details>"].join("\n");
|
|
225
225
|
};
|
|
226
|
+
const renderPublicationWarnings = (reports) => {
|
|
227
|
+
const missing = reports.filter((report) => report.published === false);
|
|
228
|
+
return missing.length
|
|
229
|
+
? ["**⚠ Expected reports were not published**", ...missing.map(({ name }) => `- ${inlineCode(name)}`)].join("\n\n")
|
|
230
|
+
: undefined;
|
|
231
|
+
};
|
|
226
232
|
export const renderReportSummaryMarkdown = (context, options = {}) => {
|
|
227
233
|
const { title = "Allure Report Summary", includeArtifacts = true } = options;
|
|
228
234
|
const regularReports = context.reports.filter((report) => report.filtered !== true);
|
|
@@ -252,6 +258,7 @@ export const renderReportSummaryMarkdown = (context, options = {}) => {
|
|
|
252
258
|
const sections = [
|
|
253
259
|
`# ${escapeHtml(title)}`,
|
|
254
260
|
renderTable(aggregateRows, includeResolutions, renderOptions),
|
|
261
|
+
renderPublicationWarnings(context.reports),
|
|
255
262
|
...renderReportLinks(regularReports),
|
|
256
263
|
renderFilteredReports(filteredReports, renderOptions),
|
|
257
264
|
includeArtifacts ? renderArtifacts(context.artifacts) : undefined,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@allurereport/ci",
|
|
3
|
-
"version": "3.22.
|
|
3
|
+
"version": "3.22.1",
|
|
4
4
|
"description": "Utilities set to get useful report data from different CI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"allure",
|
|
@@ -33,13 +33,13 @@
|
|
|
33
33
|
"lint:fix": "vp lint --import-plugin --fix src test features stories"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@allurereport/core-api": "3.22.
|
|
37
|
-
"@allurereport/plugin-api": "3.22.
|
|
36
|
+
"@allurereport/core-api": "3.22.1",
|
|
37
|
+
"@allurereport/plugin-api": "3.22.1",
|
|
38
38
|
"axios": "^1.20.0",
|
|
39
39
|
"glob": "^13.0.6"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@allurereport/common-config": "3.22.
|
|
42
|
+
"@allurereport/common-config": "3.22.1",
|
|
43
43
|
"@types/node": "^20",
|
|
44
44
|
"@vitest/coverage-istanbul": "5.0.4",
|
|
45
45
|
"@vitest/runner": "^2",
|