From afb5e515330611076639fc0bb0fc147de14293f0 Mon Sep 17 00:00:00 2001 From: Sam Houlder Date: Thu, 25 Jul 2024 14:54:03 +0200 Subject: [PATCH 1/3] test-trigger-for-pipeline --- test-trigger-for-pipeline | 1 + 1 file changed, 1 insertion(+) create mode 100644 test-trigger-for-pipeline diff --git a/test-trigger-for-pipeline b/test-trigger-for-pipeline new file mode 100644 index 00000000..7bae0100 --- /dev/null +++ b/test-trigger-for-pipeline @@ -0,0 +1 @@ +test-trigger-for-pipeline \ No newline at end of file From c671403f3c6d4dd2e914dd7dba5632323a845310 Mon Sep 17 00:00:00 2001 From: Sam Houlder Date: Thu, 25 Jul 2024 15:00:35 +0200 Subject: [PATCH 2/3] Delete test-trigger-for-pipeline --- test-trigger-for-pipeline | 1 - 1 file changed, 1 deletion(-) delete mode 100644 test-trigger-for-pipeline diff --git a/test-trigger-for-pipeline b/test-trigger-for-pipeline deleted file mode 100644 index 7bae0100..00000000 --- a/test-trigger-for-pipeline +++ /dev/null @@ -1 +0,0 @@ -test-trigger-for-pipeline \ No newline at end of file From 29cfa8dbe3769cf1cef465443935a14bcaa403c0 Mon Sep 17 00:00:00 2001 From: PaulDalek Date: Thu, 1 Aug 2024 17:02:11 +0200 Subject: [PATCH 3/3] Added breaking changes list in the changelog. --- CHANGELOG.md | 22 +++++++++++++--------- README.md | 2 +- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cce67244..be50937b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # 4.0.0 +_Breaking Changes:_ + +- Reordered the `error` and `info` arguments in the callback of the `startExport` function. +- Renamed the environment variables for a better representation of their roles (refer to all envs in the README's `Environment Variables` section). +- Renamed the `HIGHCHARTS_MODULES` environment variable to `HIGHCHARTS_MODULE_SCRIPTS`. +- Renamed the `HIGHCHARTS_INDICATORS` environment variables to `HIGHCHARTS_INDICATOR_SCRIPTS`. +- Renamed the `POOL_LISTEN_TO_PROCESS_EXITS` environment variable to `OTHER_LISTEN_TO_PROCESS_EXITS`. +- Renamed the `customCode` section of the options config to the `customLogic` in order to avoid confusion with the existing `customCode` property within. +- Renamed the `scripts` property in the `highcharts` section of the options config to the `customScripts`. +- Renamed the `initPool` function to `initExport` in the main module. +- Renamed the `init` function to `initPool` in the pool module. + _New Features:_ - Implemented debug mode, including new environment variables, a config section, 'console' event listener, and npm script for debugging the headful Puppeteer browser. @@ -27,16 +39,9 @@ _Enhancements:_ - Made corrections for gracefully shutting down resources, including running servers, ongoing intervals, browser instance, created pages, and workers pool. - Updated `createImage` and `createPDF` functions with faster execution options including `optimizeForSpeed` and `quality`. - Set `waitUntil` to 'domcontentloaded' for `setContent` and `goto` functions to improve performance. -- Replaced browser's deprecated `isConnected()` with the `onnected` property. +- Replaced browser's deprecated `isConnected()` with the `connected` property. - Added information on all available pool resources. - Numerous minor improvements for performance and stability. -- Changed the `customCode` section of options to `customLogic` in order to avoid confusion with the existing `customCode` property within. -- Renamed the environment variables for a better representation of their roles (refer to all envs in the README's `Environment Variables` section). -- Renamed the `HIGHCHARTS_MODULES` and `HIGHCHARTS_INDICATORS` environment variables respectively to `HIGHCHARTS_MODULE_SCRIPTS` and `HIGHCHARTS_INDICATOR_SCRIPTS`. -- Renamed the `scripts` property of the config options to `customScripts`. -- Renamed the `initPool` function to `initExport` in the main module. -- Renamed the `init` function to `initPool` in the pool module. -- Renamed the environment variable `POOL_LISTEN_TO_PROCESS_EXITS` to `OTHER_LISTEN_TO_PROCESS_EXITS`. - Moved the `listenToProcessExits` from the `pool` to the `other` section of the options. - Replaced the temporary benchmark module with a simpler server benchmark for evaluating export time. - Removed unnecessary separate `body-parser` package (already implemented in Express v4.16+). @@ -53,7 +58,6 @@ _Enhancements:_ - Added a new process event handler for the `SIGHUP` signal. - Added `mapChart` and `ganttChart` constructors in the exporting UI [(#503)](https://github.com/highcharts/node-export-server/issues/503). - Added the series-on-point module [(#532)](https://github.com/highcharts/node-export-server/issues/532). -- Reordered the `error` and `info` arguments in the callback of the `startExport` function. - Updates were made to the `config.js` file. - Updated the `killPool` function. - The `uncaughtException` handler now kills the pool, browser, and terminates the process with exit code 1, when enabled. diff --git a/README.md b/README.md index 8c6941e6..effeb48f 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Additionally, with the v3 release, we transitioned from HTTP to HTTPS for export ## Changelog -**The v4 introduces numerous breaking changes. For further details, please refer to the changelog document provided below.** +**Version 4 introduces some breaking changes, mostly related to renamed options, environment variables, function names, and reordered function parameters. For further details, please refer to the changelog document provided below, under the Breaking Changes section.** The full change log for all versions can be viewed [here](CHANGELOG.md).