Skip to content

Commit ac31915

Browse files
AmsterGetAmsterGet
authored
Merge pull request #27 from reportportal/develop
Release 5.1.0
2 parents 2fe654c + 931346f commit ac31915

File tree

9 files changed

+1900
-1751
lines changed

9 files changed

+1900
-1751
lines changed

‎.github/workflows/CI-pipeline.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2021 EPAM Systems
1+
# Copyright 2024 EPAM Systems
22
# Licensed under the Apache License, Version 2.0 (the "License");
33
# you may not use this file except in compliance with the License.
44
# You may obtain a copy of the License at
@@ -28,13 +28,13 @@ jobs:
2828
runs-on: ubuntu-latest
2929
steps:
3030
- name: Checkout repository
31-
uses: actions/checkout@v3
31+
uses: actions/checkout@v4
3232
- name: Set up Node.js
33-
uses: actions/setup-node@v3
33+
uses: actions/setup-node@v4
3434
with:
35-
node-version: 18
36-
- name: Clean install of node dependencies
37-
run: npm ci
35+
node-version: 20
36+
- name: Install of node dependencies
37+
run: npm install
3838
- name: Build the source code
3939
run: npm run build
4040
- name: Run lint

‎.github/workflows/publish.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2021 EPAM Systems
1+
# Copyright 2024 EPAM Systems
22
# Licensed under the Apache License, Version 2.0 (the "License");
33
# you may not use this file except in compliance with the License.
44
# You may obtain a copy of the License at
@@ -22,13 +22,13 @@ jobs:
2222
runs-on: ubuntu-latest
2323
steps:
2424
- name: Checkout repository
25-
uses: actions/checkout@v3
25+
uses: actions/checkout@v4
2626
- name: Set up Node.js
27-
uses: actions/setup-node@v3
27+
uses: actions/setup-node@v4
2828
with:
29-
node-version: 18
30-
- name: Clean install of node dependencies
31-
run: npm ci
29+
node-version: 20
30+
- name: Install of node dependencies
31+
run: npm install
3232
- name: Build the source code
3333
run: npm run build
3434
- name: Run lint
@@ -41,14 +41,14 @@ jobs:
4141
runs-on: ubuntu-latest
4242
steps:
4343
- name: Checkout repository
44-
uses: actions/checkout@v3
44+
uses: actions/checkout@v4
4545
- name: Set up Node.js
46-
uses: actions/setup-node@v3
46+
uses: actions/setup-node@v4
4747
with:
48-
node-version: 18
48+
node-version: 20
4949
registry-url: 'https://registry.npmjs.org'
50-
- name: Clean install of node dependencies
51-
run: npm ci
50+
- name: Install of node dependencies
51+
run: npm install
5252
- name: Build the source code
5353
run: npm run build
5454
- name: Publish to NPM
@@ -59,9 +59,9 @@ jobs:
5959
env:
6060
NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}
6161
- name: Set up Node.js
62-
uses: actions/setup-node@v3
62+
uses: actions/setup-node@v4
6363
with:
64-
node-version: 18
64+
node-version: 20
6565
registry-url: 'https://npm.pkg.github.com'
6666
scope: '@reportportal'
6767
- name: Publish to GPR

‎.github/workflows/release.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2021 EPAM Systems
1+
# Copyright 2024 EPAM Systems
22
# Licensed under the Apache License, Version 2.0 (the "License");
33
# you may not use this file except in compliance with the License.
44
# You may obtain a copy of the License at
@@ -33,7 +33,7 @@ jobs:
3333
releaseVersion: ${{ steps.exposeVersion.outputs.releaseVersion }}
3434
steps:
3535
- name: Checkout repository
36-
uses: actions/checkout@v3
36+
uses: actions/checkout@v4
3737
- name: Read version
3838
id: readVersion
3939
run: |
@@ -78,9 +78,9 @@ jobs:
7878
versionInfo: ${{ steps.readChangelogEntry.outputs.log_entry }}
7979
steps:
8080
- name: Checkout repository
81-
uses: actions/checkout@v3
81+
uses: actions/checkout@v4
8282
- name: Setup NodeJS
83-
uses: actions/setup-node@v3
83+
uses: actions/setup-node@v4
8484
with:
8585
node-version: '12'
8686
- name: Configure git
@@ -130,6 +130,7 @@ jobs:
130130
echo "patch" > ${{ env.versionFragmentFileName }}
131131
git status
132132
git add ${{ env.versionFileName }}
133+
git add ${{ env.versionFragmentFileName }}
133134
git commit -m "${{ needs.calculate-version.outputs.releaseVersion }} -> ${{ steps.bumpSnapshotVersion.outputs.next-version }}-SNAPSHOT"
134135
git push origin develop
135136
@@ -138,7 +139,7 @@ jobs:
138139
runs-on: ubuntu-latest
139140
steps:
140141
- name: Checkout repository
141-
uses: actions/checkout@v3
142+
uses: actions/checkout@v4
142143
- name: Create Release
143144
id: createRelease
144145
uses: actions/create-release@v1

‎CHANGELOG.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1+
### Changed
2+
- **Breaking change** Drop support of Node.js 10. The version [5.0.1](https://github.com/reportportal/agent-js-testcafe/releases/tag/v5.0.1) is the latest that supports it.
3+
- `@reportportal/client-javascript` bumped to version `5.1.4`, new `launchUuidPrintOutput` types introduced: 'FILE', 'ENVIRONMENT'.
4+
### Security
5+
- Updated versions of vulnerable packages (braces).
6+
### Deprecated
7+
- Node.js 12 usage. This minor version is the latest that supports Node.js 12.
18

29
## [5.0.1] - 2024-01-19
310
### Changed
411
- `@reportportal/client-javascript` bumped to version `5.0.15`.
512
- Package size reduced
613
### Deprecated
7-
- Node.js 10 usage. This version is the latest that supports Node.js 10.
14+
- Node.js 10 usage. This minor version is the latest that supports Node.js 10.
815

916
## [5.0.0] - 2021-08-11
1017
### Added

‎README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,40 +18,41 @@ npm install --save-dev testcafe-reporter-agent-js-testcafe@npm:@reportportal/tes
1818
**1.** Create `rp.json` file with reportportal configuration:
1919
```json
2020
{
21-
"token": "00000000-0000-0000-0000-000000000000",
22-
"endpoint": "https://your.reportportal.server/api/v1",
23-
"project": "YourReportPortalProjectName",
24-
"launch": "YourLauncherName",
25-
"attributes": [
26-
{
27-
"key": "YourKey",
28-
"value": "YourValue"
29-
},
30-
{
31-
"value": "YourValue"
32-
}
33-
],
34-
"description": "Your launch description",
35-
"rerun": true,
36-
"rerunOf": "launchUuid of already existed launch",
37-
"mode": "DEFAULT",
38-
"skippedIssue": true,
39-
"debug": false
21+
"apiKey": "<API_KEY>",
22+
"endpoint": "https://your.reportportal.server/api/v1",
23+
"project": "YourReportPortalProjectName",
24+
"launch": "YourLauncherName",
25+
"attributes": [
26+
{
27+
"key": "YourKey",
28+
"value": "YourValue"
29+
},
30+
{
31+
"value": "YourValue"
32+
}
33+
],
34+
"description": "Your launch description"
4035
}
4136
```
4237

43-
| Parameter | Description |
44-
| --------------------- | ----------------------------------------------------------------------------------------------------------------- |
45-
| token | User's Report Portal token from which you want to send requests. It can be found on the profile page of this user.|
46-
| endpoint | URL of your server. For example 'https://server:8080/api/v1'. |
47-
| launch | Name of launch at creation. |
48-
| project | The name of the project in which the launches will be created. |
49-
| rerun | *Default: false.* Enable [rerun](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md)|
50-
| rerunOf | UUID of launch you want to rerun. If not specified, report portal will update the latest launch with the same name|
51-
| mode | Launch mode. Allowable values *DEFAULT* (by default) or *DEBUG*.|
52-
| skippedIssue | *Default: true.* ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side.<br> Parameter could be equal boolean values:<br> *TRUE* - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal.<br> *FALSE* - skipped tests will not be marked as 'To Investigate' on application.|
53-
| debug | This flag allows seeing the logs of the client-javascript. Useful for debugging.|
54-
38+
| Option | Necessity | Default | Description |
39+
|-----------------------|------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
40+
| apiKey | Required | | User's reportportal token from which you want to send requests. It can be found on the profile page of this user. |
41+
| endpoint | Required | | URL of your server. For example 'https://server:8080/api/v1'. |
42+
| launch | Required | | Name of launch at creation. |
43+
| project | Required | | The name of the project in which the launches will be created. |
44+
| attributes | Optional | [] | Launch attributes. |
45+
| description | Optional | '' | Launch description. |
46+
| rerun | Optional | false | Enable [rerun](https://reportportal.io/docs/dev-guides/RerunDevelopersGuide) |
47+
| rerunOf | Optional | Not set | UUID of launch you want to rerun. If not specified, reportportal will update the latest launch with the same name |
48+
| mode | Optional | 'DEFAULT' | Results will be submitted to Launches page <br/> *'DEBUG'* - Results will be submitted to Debug page (values must be upper case). |
49+
| debug | Optional | false | This flag allows seeing the logs of the client-javascript. Useful for debugging. |
50+
| restClientConfig | Optional | Not set | `axios` like http client [config](https://github.com/axios/axios#request-config). May contain `agent` property for configure [http(s)](https://nodejs.org/api/https.html#https_https_request_url_options_callback) client, and other client options e.g. `proxy`, [`timeout`](https://github.com/reportportal/client-javascript#timeout-30000ms-on-axios-requests). For debugging and displaying logs the `debug: true` option can be used. <br/> Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details. |
51+
| headers | Optional | {} | The object with custom headers for internal http client. |
52+
| launchUuidPrint | Optional | false | Whether to print the current launch UUID. |
53+
| launchUuidPrintOutput | Optional | 'STDOUT' | Launch UUID printing output. Possible values: 'STDOUT', 'STDERR', 'FILE', 'ENVIRONMENT'. Works only if `launchUuidPrint` set to `true`. File format: `rp-launch-uuid-${launch_uuid}.tmp`. Env variable: `RP_LAUNCH_UUID`, note that the env variable is only available in the reporter process (it cannot be obtained from tests). |
54+
| skippedIssue | Optional | true | reportportal provides feature to mark skipped tests as not 'To Investigate'. <br/> Option could be equal boolean values: <br/> *true* - skipped tests considered as issues and will be marked as 'To Investigate' on reportportal. <br/> *false* - skipped tests will not be marked as 'To Investigate' on application. |
55+
| token | Deprecated | Not set | Use `apiKey` instead. |
5556

5657
**2.1** Create `.testcaferc.json` TestCafe [configuration file](https://testcafe.io/documentation/402638/reference/configuration-file) and add `agent-js-testcafe` to the `reporter` property
5758
```json
@@ -97,7 +98,6 @@ Run tests via `node testcafe.js`.
9798

9899
> **Note:** TestCafe options from `.testcaferc.json` can be overwritten programmatically in `testcafe.js`
99100
100-
101101
## Reporting
102102

103103
This reporter provides Reporting API to use it directly in tests to send some additional data to the report.

‎VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.0.1
1+
5.0.2-SNAPSHOT

0 commit comments

Comments
 (0)