Simplifies re2 upgrade instructions (opensearch-project#3328)

* Follow-up from opensearch-project#3018 Signed-off-by: Tommy Markley <[email protected]> (cherry picked from commit 844059c)
joshuarrrr · Mar 8, 2023 · c19610f · c19610f
1 parent 3f6b696
commit c19610f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -58,6 +58,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))
 
 ### 🛠 Maintenance
 

diff --git 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',