From a635d8aad63784b719856cf64ec519fabcbab290 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Sat, 5 Jul 2025 12:47:10 -0300 Subject: [PATCH 1/6] chore: run `npm audit fix` --- package-lock.json | 50 +++++++++++++++++++++++++++-------------------- package.json | 2 +- 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/package-lock.json b/package-lock.json index 169ff5d8..f0610a52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2120,10 +2120,11 @@ "dev": true }, "node_modules/@types/http-proxy": { - "version": "1.17.15", - "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.15.tgz", - "integrity": "sha512-25g5atgiVNTIv0LBDTg1H74Hvayx0ajtJPLLcYE3whFv75J0pWNtOBzaXJQgDTmrX1bx5U9YC2w/n65BN1HwRQ==", + "version": "1.17.16", + "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.16.tgz", + "integrity": "sha512-sdWoUajOB1cd0A8cRRQ1cfyWNbmFKLAqBB89Y8x5iYyG/mkJHc0YUH8pdWBy2omi9qtCpiIgGjuwO0dQST2l5w==", "dev": true, + "license": "MIT", "dependencies": { "@types/node": "*" } @@ -2476,10 +2477,11 @@ } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } @@ -3198,9 +3200,9 @@ "dev": true }, "node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", + "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", "dev": true, "license": "MIT", "dependencies": { @@ -5055,9 +5057,9 @@ } }, "node_modules/filelist/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", "dev": true, "license": "MIT", "dependencies": { @@ -5169,6 +5171,7 @@ "url": "https://github.com/sponsors/RubenVerborgh" } ], + "license": "MIT", "engines": { "node": ">=4.0" }, @@ -5590,6 +5593,7 @@ "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", "dev": true, + "license": "MIT", "dependencies": { "eventemitter3": "^4.0.0", "follow-redirects": "^1.0.0", @@ -5600,9 +5604,9 @@ } }, "node_modules/http-proxy-middleware": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.7.tgz", - "integrity": "sha512-fgVY8AV7qU7z/MmXJ/rxwbrtQH4jBQ9m7kp3llF0liB7glmFeVZFBepQb32T3y8n8k2+AEYuMPCpinYW+/CuRA==", + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", + "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", "dev": true, "license": "MIT", "dependencies": { @@ -5628,7 +5632,8 @@ "version": "4.0.7", "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/human-signals": { "version": "2.1.0", @@ -5927,6 +5932,7 @@ "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -11277,7 +11283,8 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/resolve": { "version": "1.22.8", @@ -12831,15 +12838,16 @@ } }, "node_modules/webpack-dev-server": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-5.2.0.tgz", - "integrity": "sha512-90SqqYXA2SK36KcT6o1bvwvZfJFcmoamqeJY7+boioffX9g9C0wjjJRGUrQIuh43pb0ttX7+ssavmj/WN2RHtA==", + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-5.2.2.tgz", + "integrity": "sha512-QcQ72gh8a+7JO63TAx/6XZf/CWhgMzu5m0QirvPfGvptOusAxG12w2+aua1Jkjr7hzaWDnJ2n6JFeexMHI+Zjg==", "dev": true, "license": "MIT", "dependencies": { "@types/bonjour": "^3.5.13", "@types/connect-history-api-fallback": "^1.5.4", "@types/express": "^4.17.21", + "@types/express-serve-static-core": "^4.17.21", "@types/serve-index": "^1.9.4", "@types/serve-static": "^1.15.5", "@types/sockjs": "^0.3.36", @@ -12852,7 +12860,7 @@ "connect-history-api-fallback": "^2.0.0", "express": "^4.21.2", "graceful-fs": "^4.2.6", - "http-proxy-middleware": "^2.0.7", + "http-proxy-middleware": "^2.0.9", "ipaddr.js": "^2.1.0", "launch-editor": "^2.6.1", "open": "^10.0.3", diff --git a/package.json b/package.json index 91448c00..ab943695 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,7 @@ "test": "jest", "start": "webpack serve --open --config webpack.dev.js", "start-host": "webpack serve --config webpack.dev.js --host 0.0.0.0", - "build": "webpack --config webpack.prod.js", + "build": "rm -rf dist/ && webpack --config webpack.prod.js", "format": "prettier . --write", "lint": "prettier . --check && eslint src/" }, From 5776d85c37b680c9b73600a8c36b47174f770bb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Sat, 5 Jul 2025 12:47:19 -0300 Subject: [PATCH 2/6] docs: add release instructions --- RELEASE.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..a8bdfaf7 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,27 @@ +# How to release + +To make a release: + +- [ ] Make sure you have the latest changes on `main`: + + ```sh + git checkout main && git pull origin main + ``` + +- [ ] Build the artifacts with `npm run build` +- [ ] Package the artifacts: + + ```sh + tar -czvf gedusim.tar.gz dist/* README.md LICENSE + ``` + +- [ ] Create a new GitHub release with the packaged artifacts. + +- [ ] Add information on how to run the release: + + > To serve the files locally: + > + > 1. Extract the artifacts with `tar -xzf gedusim.tar.gz` + > 2. Run `python3 -m http.server 8080` + > + > You'll now be able to use the simulator locally by going to `http://localhost:8080` From 4bc303b93e04128852d1887e81aee7ef8c6c6ff6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Sat, 5 Jul 2025 12:48:35 -0300 Subject: [PATCH 3/6] docs: improve info on step --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index a8bdfaf7..ba9b7ea2 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -9,7 +9,7 @@ To make a release: ``` - [ ] Build the artifacts with `npm run build` -- [ ] Package the artifacts: +- [ ] Package the artifacts with the readme and license: ```sh tar -czvf gedusim.tar.gz dist/* README.md LICENSE From 8c6db25db723456d82f46c1d0bd455c65bc03f3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Sat, 5 Jul 2025 13:03:24 -0300 Subject: [PATCH 4/6] docs: add examples to release --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index ba9b7ea2..caa43a13 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -12,7 +12,7 @@ To make a release: - [ ] Package the artifacts with the readme and license: ```sh - tar -czvf gedusim.tar.gz dist/* README.md LICENSE + tar -czvf gedusim.tar.gz examples/* dist/* README.md LICENSE ``` - [ ] Create a new GitHub release with the packaged artifacts. From 362216bad6389e5137873c64dacd8dd5cc3af282 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Sat, 5 Jul 2025 13:03:33 -0300 Subject: [PATCH 5/6] docs: improve "how to serve" instructions --- RELEASE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index caa43a13..c412e561 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -21,7 +21,8 @@ To make a release: > To serve the files locally: > - > 1. Extract the artifacts with `tar -xzf gedusim.tar.gz` - > 2. Run `python3 -m http.server 8080` + > 1. Download the compiled artifacts (`gedusim.tar.gz`). + > 2. Extract the artifacts with `tar -xzf gedusim.tar.gz`. + > 3. Serve the files under `dist/` through a web server, (i.e. [http-server](https://www.npmjs.com/package/http-server)). > > You'll now be able to use the simulator locally by going to `http://localhost:8080` From 3a8326cc39693fe118728a21557b2295395672a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Sat, 5 Jul 2025 13:05:37 -0300 Subject: [PATCH 6/6] docs: expand command --- RELEASE.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index c412e561..c2b21bc1 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -8,7 +8,12 @@ To make a release: git checkout main && git pull origin main ``` -- [ ] Build the artifacts with `npm run build` +- [ ] Build the artifacts with: + + ```sh + npm run build + ``` + - [ ] Package the artifacts with the readme and license: ```sh