From 654faed678417b5a9c508e2cfe1eeb2fdcd1dfc8 Mon Sep 17 00:00:00 2001 From: Ryan Tan <65996005+ryn5@users.noreply.github.com> Date: Tue, 19 Dec 2023 17:02:05 -0800 Subject: [PATCH] Minor update to GLV examples (#2409) --- bin/run-examples.sh | 4 ++-- docs/src/dev/developer/release.asciidoc | 5 +++-- gremlin-javascript/examples/package-lock.json | 4 ++-- gremlin-javascript/examples/package.json | 4 ++-- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/bin/run-examples.sh b/bin/run-examples.sh index 5548404ec86..430cb030178 100755 --- a/bin/run-examples.sh +++ b/bin/run-examples.sh @@ -36,7 +36,7 @@ docker pull tinkerpop/gremlin-server docker run -d --rm -p 8182:8182 --name glv-examples --health-cmd="curl -f http://localhost:8182/ || exit 1" --health-interval=5s --health-timeout=3s tinkerpop/gremlin-server echo -echo "Not having docker open initially may cause an error loop. If so, simply restart this script." +echo "Not having Docker open initially or occupying port 8182 may cause an error loop. If so, simply restart this script." echo -n "Starting Gremlin server on port 8182..." until docker inspect --format '{{.State.Health.Status}}' glv-examples | grep -q "healthy"; do echo -n "." @@ -44,7 +44,7 @@ until docker inspect --format '{{.State.Health.Status}}' glv-examples | grep -q done echo -cd ../gremlin-driver/src/main/java/examples || exit +cd gremlin-driver/src/main/java/examples || exit mvn clean install echo diff --git a/docs/src/dev/developer/release.asciidoc b/docs/src/dev/developer/release.asciidoc index 92e4dea2d66..aaf1b8e1e47 100644 --- a/docs/src/dev/developer/release.asciidoc +++ b/docs/src/dev/developer/release.asciidoc @@ -80,7 +80,7 @@ Take care to commit or not commit changes related to that as necessary. == Release Manager Requirements -If this is your first time as release manager, you will need to setup keys for signing purposes per the Apache +If this is your first time as release manager, you will need to set up keys for signing purposes per the Apache release process. Generally speaking, this will mean that you will need to generate a key-pair and then publish your public key. @@ -120,7 +120,6 @@ during this period. .. Run the full integration test suite: `docker/build.sh -t -i -n` .. Build and test the Docker images: `mvn clean install -pl gremlin-server,gremlin-console -DdockerImages` .. Ensure that the Gremlin.Net.Template gets packaged successfully: `mvn clean install -pl :gremlin-dotnet-source -Dnuget` -.. Ensure that the GLV examples are compiling and running successfully: `bin/run-examples.sh` .. Deploy a final SNAPSHOT to the Apache snapshot repository for Java. .. Review LICENSE and NOTICE files to make sure that no <>. .. Review javadoc filters on the "Core API" docs to be sure nothing needs to change. @@ -328,6 +327,8 @@ the help of a PMC member for those steps. .. Commit and push the `SNAPSHOT` changes to git . Examine the `future.asciidoc` and update the "Roadmap" as needed. . Send email to advise that code freeze is lifted. +. Ensure that the GLV examples compile and run with the latest image and dependencies: `bin/run-examples.sh`. +.. Make changes as necessary to update the examples. . Generate a list of dead branches that will be automatically deleted and post them as a DISCUSS thread for review, then once consensus is reached removed those branches. . Set up the IO tests for the current `SNAPSHOT` as discussed in the <> diff --git a/gremlin-javascript/examples/package-lock.json b/gremlin-javascript/examples/package-lock.json index 4898ff144d0..228eed50de7 100644 --- a/gremlin-javascript/examples/package-lock.json +++ b/gremlin-javascript/examples/package-lock.json @@ -1,11 +1,11 @@ { - "name": "example", + "name": "examples", "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "example", + "name": "examples", "version": "1.0.0", "license": "Apache-2.0", "dependencies": { diff --git a/gremlin-javascript/examples/package.json b/gremlin-javascript/examples/package.json index 05e0bebf832..7bdd54dec4a 100644 --- a/gremlin-javascript/examples/package.json +++ b/gremlin-javascript/examples/package.json @@ -1,8 +1,8 @@ { - "name": "example", + "name": "examples", "version": "1.0.0", "description": "GLV example for JavaScript with Node", - "main": "example.js", + "main": "connections.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" },