diff --git a/CHANGELOG.md b/CHANGELOG.md index f0f1db1ce5a4..e0c5a223faa0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -61,6 +61,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Corrected README and help command of osd-plugin-helpers ([#2810](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2810)) - Add the release runbook to RELEASING.md ([#2533](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2533)) +- Simplify the in-code instructions for upgrading `re2` ([#3328](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3328)) - [Doc] Improve DEVELOPER_GUIDE to make first time setup quicker and easier ([#3421](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3421)) ### 🛠 Maintenance diff --git a/src/dev/build/tasks/patch_native_modules_task.ts b/src/dev/build/tasks/patch_native_modules_task.ts index 3ed94038caf1..65dbd40f58f0 100644 --- a/src/dev/build/tasks/patch_native_modules_task.ts +++ b/src/dev/build/tasks/patch_native_modules_task.ts @@ -49,6 +49,16 @@ interface Package { >; } +/* Process for updating URLs and checksums after bumping the version of `re2` or NodeJS: + * 1. Match the `version` with the version in the yarn.lock file. + * 2. Match the module version, the digits at the end of the filename, with the output of + * `node -p process.versions.modules`. + * 3. Confirm that the URLs exist for each platform-architecture combo on + * https://github.com/uhop/node-re2/releases/tag/[VERSION]; reach out to maintainers for ARM + * releases of `re2` as they currently don't have an official ARM release. + * 4. Generate new checksums for each artifact by downloading each one and calling + * `shasum -a 256` or `sha256sum` on the downloaded file. + */ const packages: Package[] = [ { name: 're2',