Skip to content

Commit 844059c

Browse files
authored
Simplifies re2 upgrade instructions (#3328)
* Follow-up from #3018 Signed-off-by: Tommy Markley <5437176+tmarkley@users.noreply.github.com>
1 parent 81a5fad commit 844059c

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
128128
- [Doc] Add current plugin persistence implementation readme ([#3081](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3081))
129129
- [Doc] Improve DEVELOPER_GUIDE to make first time setup quicker and easier ([#3421](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3421))
130130
- Correct copyright date range of NOTICE file and notice generator ([#3308](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3308))
131+
- Simplify the in-code instructions for upgrading `re2` ([#3328](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3328))
131132

132133
### 🛠 Maintenance
133134

src/dev/build/tasks/patch_native_modules_task.ts

+10-11
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,16 @@ interface Package {
5252
>;
5353
}
5454

55-
// Process for updating urls and checksums after bumping the version of `re2`:
56-
// 1. Match `version` with the version in the yarn.lock file.
57-
// 2. Update the url to match the version.
58-
// 2a. If a Node.js update occurs, the node module version must match as
59-
// well (i.e. '83'). See https://nodejs.org/en/download/releases/#ref-1.
60-
// 3. Generate the new checksum by executing the following commands:
61-
// 3a. `wget {url}`
62-
// 3b. `sha256sum {downloaded file name}`
63-
// 3c. For `linux-arm64`, the sha256 can also be found by replacing
64-
// "linux-arm64-83.tar.gz" in the url with "sha256sum.txt.asc"
65-
// and copying the sha256 from that file.
55+
/* Process for updating URLs and checksums after bumping the version of `re2` or NodeJS:
56+
* 1. Match the `version` with the version in the yarn.lock file.
57+
* 2. Match the module version, the digits at the end of the filename, with the output of
58+
* `node -p process.versions.modules`.
59+
* 3. Confirm that the URLs exist for each platform-architecture combo on
60+
* https://github.com/uhop/node-re2/releases/tag/[VERSION]; reach out to maintainers for ARM
61+
* releases of `re2` as they currently don't have an official ARM release.
62+
* 4. Generate new checksums for each artifact by downloading each one and calling
63+
* `shasum -a 256` or `sha256sum` on the downloaded file.
64+
*/
6665
const packages: Package[] = [
6766
{
6867
name: 're2',

0 commit comments

Comments
 (0)