From dccb1ce7ed6e782925781efd581e5621577ea03e Mon Sep 17 00:00:00 2001 From: Ilya Hancharyk Date: Wed, 31 Jul 2024 18:44:35 +0200 Subject: [PATCH] Update changelog --- CHANGELOG.md | 9 +++++++++ README.md | 30 +++++++++++++++--------------- 2 files changed, 24 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f6205b..d38e33f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +### Changed +- **Breaking change** Drop support of Node.js 12. The version [5.1.4](https://github.com/reportportal/client-javascript/releases/tag/v5.1.4) is the latest that supports it. +### Fixed +- Proxy support on HTTPS requests. Resolves [#30](https://github.com/reportportal/client-javascript/issues/30), related to [axios#4531](https://github.com/axios/axios/issues/4531). +- Allow using `restClientConfig` in `checkConnect()` method. Thanks to [stevez](https://github.com/stevez). +### Security +- Updated versions of vulnerable packages (braces). ## [5.1.4] - 2024-05-22 ### Fixed @@ -23,6 +30,8 @@ - **Breaking change** Drop support of Node.js 10. The version [5.0.15](https://github.com/reportportal/client-javascript/releases/tag/v5.0.15) is the latest that supports it. ### Security - Updated versions of vulnerable packages (axios, follow-redirects). +### Deprecated +- Node.js 12 usage. This minor version is the latest that supports Node.js 12. ## [5.0.15] - 2023-11-20 ### Added diff --git a/README.md b/README.md index 9dafc34..586d230 100644 --- a/README.md +++ b/README.md @@ -53,24 +53,24 @@ rpClient.checkConnect().then((response) => { When creating a client instance, you need to specify the following options: -| Option | Necessity | Default | Description | -|-----------------------|------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| apiKey | Required | | User's reportportal token from which you want to send requests. It can be found on the profile page of this user. | -| endpoint | Required | | URL of your server. For example, if you visit the page at 'https://server:8080/ui', then endpoint will be equal to 'https://server:8080/api/v1'. | -| launch | Required | | Name of the launch at creation. | -| project | Required | | The name of the project in which the launches will be created. | -| headers | Optional | {} | The object with custom headers for internal http client. | -| debug | Optional | false | This flag allows seeing the logs of the client. Useful for debugging. | -| isLaunchMergeRequired | Optional | false | Allows client to merge launches into one at the end of the run via saving their UUIDs to the temp files at filesystem . At the end of the run launches can be merged using `mergeLaunches` method. Temp file format: `rplaunch-${launch_uuid}.tmp`. | -| 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 eg. `timeout`. For debugging and displaying logs you can set `debug: true`. | -| launchUuidPrint | Optional | false | Whether to print the current launch UUID. | -| 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`. | -| token | Deprecated | Not set | Use `apiKey` instead. | +| Option | Necessity | Default | Description | +|-----------------------|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiKey | Required | | User's reportportal token from which you want to send requests. It can be found on the profile page of this user. | +| endpoint | Required | | URL of your server. For example, if you visit the page at 'https://server:8080/ui', then endpoint will be equal to 'https://server:8080/api/v1'. | +| launch | Required | | Name of the launch at creation. | +| project | Required | | The name of the project in which the launches will be created. | +| headers | Optional | {} | The object with custom headers for internal http client. | +| debug | Optional | false | This flag allows seeing the logs of the client. Useful for debugging. | +| isLaunchMergeRequired | Optional | false | Allows client to merge launches into one at the end of the run via saving their UUIDs to the temp files at filesystem. At the end of the run launches can be merged using `mergeLaunches` method. Temp file format: `rplaunch-${launch_uuid}.tmp`. | +| 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 eg. `timeout`. For debugging and displaying logs you can set `debug: true`. | +| launchUuidPrint | Optional | false | Whether to print the current launch UUID. | +| 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`. | +| token | Deprecated | Not set | Use `apiKey` instead. | ## Asynchronous reporting -The client supports an asynchronous reporting. -If you want the client to work asynchronously change `v1` to `v2` in addresses in endpoint. +The client supports an asynchronous reporting (via the ReportPortal asynchronous API). +If you want the client to report through the asynchronous API, change `v1` to `v2` in the `endpoint` address. ## API