@xray-app/xray-automation
Advanced tools
@xray-app/xray-automation - npm Package Compare versions
Comparing version 0.1.1 to 0.1.2
@@ -16,2 +16,8 @@ # Changelog | ||
| ## [0.1.2] - 2022-03-28 | ||
| ### Fixed | ||
| - clarified docs, fix linting errors and some small bugs due to typos | ||
| ## [0.1.0] - 2022-03-28 | ||
@@ -25,3 +31,4 @@ | ||
| [unreleased]: https://github.com/Xray-App/xray-automation-js/compare/0.1.0...HEAD | ||
| [unreleased]: https://github.com/Xray-App/xray-automation-js/compare/0.1.2...HEAD | ||
| [0.1.2]: https://github.com/Xray-App/xray-automation-js/releases/tag/0.1.2 | ||
| [0.1.0]: https://github.com/Xray-App/xray-automation-js/releases/tag/0.1.0 |
| { | ||
| "name": "@xray-app/xray-automation", | ||
| "version": "0.1.1", | ||
| "version": "0.1.2", | ||
| "description": "Library for uploading test results to Xray Test Management", | ||
@@ -13,2 +13,9 @@ "type": "module", | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/Xray-App/xray-automation-js.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/Xray-App/xray-automation-js/issues" | ||
| }, | ||
| "keywords": [ | ||
@@ -15,0 +22,0 @@ "xray", |
| # Xray JavaScript client library for assisting on test automation tasks | ||
| [](https://www.npmjs.com/package/@xray-app/xray-automation) | ||
| [](https://github.com/Xray-App/xray-automation-js/actions/workflows/CI.yml) | ||
@@ -9,4 +10,4 @@ [](https://opensource.org/licenses/BSD-3-Clause) | ||
| **Core features:** | ||
| **Core features:** | ||
| - supports Xray datacenter(DC)/server, and Xray cloud | ||
@@ -18,3 +19,2 @@ - upload test automation results in different formats | ||
| ## Background | ||
@@ -36,3 +36,3 @@ | ||
| This library provides two main objects, `XrayDatacenterClient` and `XrayCloudClient`, that provide the ability to interact with Xray on Jira datacenter/server or with Xray on Jira Cloud, respectively. Therefore, and first of all, you must know which Jira deployment variant you're using. | ||
| This library provides two main objects, `XrayDatacenterClient` and `XrayCloudClient`, that provide the ability to interact with Xray on Jira datacenter/server or with Xray on Jira Cloud, respectively. Therefore, and first of all, you must know which Jira deployment variant you're using. | ||
@@ -54,3 +54,2 @@ ### Client initialization and configuration | ||
| For Xray server/datacenter, we can use basic authentication and provide a Jira username/password. | ||
@@ -78,10 +77,9 @@ For Xray datacenter on a compatible Jira DC version (>= 8.14), we can also use PAN (Personal Access Tokens). | ||
| ### Import test results to Xray (basic scenario) | ||
| To import results, we need to use the method `submitResults(reportFile, reportConfig)` on the respective Xray client object. | ||
| - `reportFile`: file with the test results (relative or absolute path) | ||
| - `reportConfig`: an object with additional settings, mostly to assign values on the corresponding Test Execution issue; possible values on the table ahead. | ||
| | setting | description | mandatory/optional| example | | ||
@@ -97,3 +95,2 @@ | --- | --- | --- | --- | | ||
| ```javascript | ||
@@ -117,3 +114,2 @@ import { XrayDatacenterClient, XrayCloudClient, JUNIT_FORMAT } from '@xray-app/xray-automation' | ||
| Please note that Xray server/DC and Xray cloud support mostly the same formats, but not exactly for legacy reasons. Besides, not all formats support the same parameters; please check the respective product documentation. The following table sums this info. | ||
@@ -132,4 +128,2 @@ | ||
| ### Import test results to Xray with customization of Test Execution and Test issues (advanced scenario) | ||
@@ -143,4 +137,4 @@ | ||
| To import results with customization possibilities, which internally will use the proper "multipart" endpoint for that test report format, we need to use the method `submitResultsMultipart(reportFile, reportConfig)` on the respective Xray client object. | ||
| To import results with customization possibilities, which internally will use the proper "multipart" endpoint for that test report format, we need to use the method `submitResultsMultipart(reportFile, reportConfig)` on the respective Xray client object. | ||
| - `reportFile`: file with the test results (relative or absolute path) | ||
@@ -157,3 +151,2 @@ - `reportConfig`: an object with additional settings; possible values on the table ahead. | ||
| ```javascript | ||
@@ -185,3 +178,2 @@ import { XrayDatacenterClient, XrayCloudClient, JUNIT_FORMAT } from '@xray-app/xray-automation' | ||
| ### Associate Test Execution to Test Plan | ||
@@ -204,3 +196,2 @@ | ||
| ## FAQ | ||
@@ -235,3 +226,2 @@ | ||
| - jest coverage badge | ||
| - npm badge | ||
| - review/refactor tests | ||
@@ -238,0 +228,0 @@ - REST API v1 support? |
Fixed alerts
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.08%
632019
- Number of low maintenance alerts
- decreased by-100%
0
- Number of low supply chain risk alerts
- decreased by-20%
4
Worsened metrics
- Number of lines in readme file
- decreased by-4.07%
236