Comment the scripts to describe their purpose.

neon-bindings · Oct 30, 2023 · 9419c14 · 9419c14
1 parent 62122e6
commit 9419c14
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/test/integration/proxy/ci-proxy.sh b/test/integration/proxy/ci-proxy.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# This script is used by CI to start up the npm proxy.
+
 CIPROXY=http://127.0.0.1:4873
 
 # Boot the server in a background process.

diff --git a/test/integration/proxy/local-proxy.sh b/test/integration/proxy/local-proxy.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# This script can be used for running the integration tests in local development.
+# It starts up the npm proxy and manages it with the pm2 process manager.
+
 cd $(dirname $0)/../../..
 ROOT_DIR=$(pwd)
 PROXY_DIR=${ROOT_DIR}/test/integration/proxy

diff --git a/test/lint/check-bundles.sh b/test/lint/check-bundles.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# This script implements a lint that ensures that generated bundles
+# in the repo haven't gone stale since the source was last modified.
+
 echo "Checking that all bundled tools are up to date..."
 
 dirty_workspaces=()