This is an automated email from the ASF dual-hosted git repository. spmallette pushed a commit to branch runtime-docs in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit 74332ad246f61c535b43b75ed8458a359eb9f9fc Author: Stephen Mallette <[email protected]> AuthorDate: Mon Oct 13 16:33:47 2025 -0400 Added runtime documentation --- docs/site/home/download.html | 40 ++++++++++------ docs/src/reference/gremlin-variants.asciidoc | 70 ++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+), 15 deletions(-) diff --git a/docs/site/home/download.html b/docs/site/home/download.html index ad70377e10..b0eb27f609 100644 --- a/docs/site/home/download.html +++ b/docs/site/home/download.html @@ -194,7 +194,7 @@ limitations under the License. <p class="mb-3 mb-md-5 medium black">Apache TinkerPop provides three packaged downloads per release version. The <a href="https://tinkerpop.apache.org/docs/current/reference/#gremlin-console"; class="text-blue">Gremlin Console</a> and <a href="https://tinkerpop.apache.org/docs/current/reference/#gremlin-server"; class="text-blue">Gremlin Server</a> downloads are binary distributions, which contain pre-packaged versions of these important TinkerPop applications that are designed to work out-of-the-box - when unpackaged. The source distribution is a snapshot of the source code and files used in the building of those binary distributions.</p> + when unpackaged. The source distribution is a snapshot of the source code and files used in the building of those binary distributions.</p> </div> <div class="col-12 mb-3s"> <h2 class="ft-25 black bold">Current Releases</h2> @@ -351,7 +351,7 @@ limitations under the License. </div> <div class="row d-flex align-items-center mt-4 mt-md-5"> <h2 class="ft-25 black bold mb-2">Packaged Artifacts</h2> - <p class="mb-4">As a convenience, TinkerPop also deploys packaged artifacts to the following locations</p> + <p class="mb-4">As a convenience, TinkerPop also deploys packaged artifacts to the following locations:</p> </div> <div class="row d-flex justify-content-center"> <div class="col-lg-11 col-md-12"> @@ -359,6 +359,7 @@ limitations under the License. <thead> <tr> <th scope="col" class="left-radius">Repository</th> + <th scope="col">Recommended Runtime</th> <th scope="col">Artifacts</th> <th scope="col" class="right-radius info-table-th"></th> </tr> @@ -366,6 +367,7 @@ limitations under the License. <tbody> <tr> <td data-label="Repository" class="bold">Docker</td> + <td data-label="Recommended Runtime">N/A</td> <td data-label="Artifacts"><a href="https://hub.docker.com/r/tinkerpop/gremlin-server"; class="text-blue">Gremlin Server </a> <br> <a href="https://hub.docker.com/r/tinkerpop/gremlin-console"; class="text-blue">Gremlin Console </a></td> <td data-label=""> <div class="code-box1"> @@ -376,16 +378,18 @@ limitations under the License. <tr> <td data-label="Repository" class="bold">Go Module</td> + <td data-label="Recommended Runtime">Go 1.24</td> <td data-label="Artifacts"><a href="https://pkg.go.dev/github.com/apache/tinkerpop/gremlin-go/v3"; class="text-blue">gremlin-go</a></td> <td data-label=""> <div class="code-box1"> - go get github.com/apache/tinkerpop/gremlin-go/v3@v3.7.0 + go get github.com/apache/tinkerpop/gremlin-go/v3@v3.7.4 </div> </td> </tr> <tr> <td data-label="Repository" class="bold">Maven Central</td> + <td data-label="Recommended Runtime">JDK 17</td> <td data-label="Artifacts"><a href="https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.tinkerpop%22"; class="text-blue">groupId: org.apache.tinkerpop </a></td> <td data-label=""> <div class="code-box1"> @@ -393,24 +397,15 @@ limitations under the License. <dependency> <br> <groupId>org.apache.tinkerpop</groupId> <br> <artifactId>gremlin-driver</artifactId> <br> - <version>3.7.0</version> <br> + <version>3.7.4</version> <br> </dependency> </div> </td> </tr> - <tr> - <td data-label="Repository" class="bold">PyPI</td> - <td data-label="Artifacts"><a href="https://pypi.python.org/pypi/gremlinpython/"; class="text-blue">gremlinpython </a> </td> - <td data-label=""> - <div class="code-box1"> - pip install gremlinpython - </div> - </td> - </tr> - <tr> <td data-label="Repository" class="bold">npm</td> + <td data-label="Recommended Runtime">Node.js 20+</td> <td data-label="Artifacts"><a href="https://www.npmjs.com/package/gremlin"; class="text-blue">gremlin </a> <br> <a href="https://www.npmjs.com/package/gremlint"; class="text-blue">gremlint </a></td> <td data-label=""> <div class="code-box1"> @@ -421,17 +416,32 @@ limitations under the License. <tr> <td data-label="Repository" class="bold">NuGet</td> + <td data-label="Recommended Runtime">.NET Standard 2.0; .NET 6.0</td> <td data-label="Artifacts"><a href="https://www.nuget.org/packages/Gremlin.Net/"; class="text-blue">Gremlin.Net </a> <br> <a href="https://www.nuget.org/packages/Gremlin.Net.Template/"; class="text-blue">Gremlin.Net.Template </a></td> <td data-label=""> <div class="code-box1"> - dotnet add package Gremlin.Net --version 3.7.0 <br>dotnet add package Gremlin.Net.template --version 3.7.0 + dotnet add package Gremlin.Net --version 3.7.4 <br>dotnet add package Gremlin.Net.template --version 3.7.4 </div> </td> </tr> + + <tr> + <td data-label="Repository" class="bold">PyPI</td> + <td data-label="Recommended Runtime">Python 3.9+</td> + <td data-label="Artifacts"><a href="https://pypi.python.org/pypi/gremlinpython/"; class="text-blue">gremlinpython </a> </td> + <td data-label=""> + <div class="code-box1"> + pip install gremlinpython + </div> + </td> + </tr> </tbody> </table> </div> + </div> + <div class="row d-flex align-items-center mt-4 mt-md-5"> + <p class="mb-4">The "Recommended Versions" listed above apply to the most recent TinkerPop release. See the Reference Documentation for more specific recommendations on runtimes for older versions for <a href="https://tinkerpop.apache.org/docs/current/reference/#gremlin-go"; class="text-blue">Go</a>, <a href="https://tinkerpop.apache.org/docs/current/reference/#gremlin-java"; class="text-blue">Java</a>, <a href="https://tinkerpop.apache.org/docs/current/reference/#greml [...] </div> <div class="row d-flex align-items-center mt-4 mt-md-5"> <h2 class="ft-25 black bold mb-2">Verifying Downloads</h2> diff --git a/docs/src/reference/gremlin-variants.asciidoc b/docs/src/reference/gremlin-variants.asciidoc index b0a4cbf580..786adaad81 100644 --- a/docs/src/reference/gremlin-variants.asciidoc +++ b/docs/src/reference/gremlin-variants.asciidoc @@ -83,6 +83,24 @@ To install the Gremlin-Go as a dependency for your project, run the following in go get github.com/apache/tinkerpop/gremlin-go/v3[optionally append @<version>, such as @v3.5.3] ---- +The following table outlines recommended runtime versions by the release in which their support began: + +[cols="1,1",options="header"] +|=== +|Version |Recommended Go Version +|3.4.0 |N/A +|3.4.13 |N/A +|3.5.0 |N/A +|3.5.4 |≥1.17 +|3.5.8 |≥1.20 +|3.6.0 |≥1.17 +|3.6.7 |≥1.21 +|3.6.8 |≥1.22 +|3.7.0 |≥1.20 +|3.7.2 |≥1.21 +|3.7.3 |≥1.22 +|=== + [[gremlin-go-connecting]] === Connecting @@ -635,6 +653,17 @@ tinkergraph-gremlin which are not shaded. </dependency> ---- +The following table outlines recommended runtime versions by the release in which their support began: + +[cols="1,2",options="header"] +|=== +|Version |Supported Java Versions +|3.4.0 | Java 8 +|3.5.0 | Java 8, 11 +|3.6.0 | Java 8, 11 +|3.7.0 | Java 8, 11, 17 +|=== + [[gremlin-java-connecting]] === Connecting @@ -1288,6 +1317,20 @@ between Gremlin-Java and Gremlin-JavaScript. [source,bash] npm install gremlin +The following table outlines recommended runtime versions by the release in which their support began: + +[cols="1,1,1,1",options="header"] +|=== +|Version |Min Node.js |npm Version |TypeScript Target +|3.4.0 |≥6.0 |N/A |N/A +|3.5.0 |≥10.0 |6.14.16 |N/A +|3.5.8 |≥16.0 |8.19.4 |N/A +|3.6.0 |≥10.0 |8.1.2 |N/A +|3.6.3 |≥10.0 |8.5.5 |N/A +|3.6.7 |≥10.0 |9.6.7 |Node18 +|3.7.0 |≥18.0 |9.6.7 |Node18 +|=== + [[gremlin-javascript-connecting]] === Connecting @@ -1739,6 +1782,18 @@ to comply with .NET conventions. [source,powershell] nuget install Gremlin.Net +The following table outlines recommended runtime versions by the release in which their support began: + +[cols="1,2,1",options="header"] +|=== +|Version |Target Frameworks |Language Version +|3.4.0 |.NET Standard 1.3; .NET Standard 2.0 |C# 7.0 +|3.5.0 |.NET Standard 2.0 |C# 8.0 +|3.5.4 |.NET Standard 2.0; .NET 6.0 |C# 9.0 +|3.6.0 |.NET Standard 2.0; .NET 6.0 |C# 9.0 +|3.7.0 |.NET Standard 2.0; .NET6.0 |C# 9.0 +|=== + [[gremlin-dotnet-connecting]] === Connecting @@ -2137,6 +2192,21 @@ pip install gremlinpython pip install gremlinpython[kerberos] # Optional, not available on Microsoft Windows ---- +The following table outlines recommended runtime versions by the release in which their support began: + +[cols="1,1,1",options="header"] +|=== +|Version |Min Python |Key Dependencies +|3.4.0 |2.7 |tornado +|3.5.0 |≥3.0 |tornado +|3.5.4 |≥3.0 |tornado +|3.5.8 |≥3.0 |aiohttp +|3.6.0 |≥3.0 |tornado +|3.6.7 |≥3.0 |aiohttp +|3.6.8 |≥3.9 |aiohttp +|3.7.0 |≥3.0 |aiohttp +|=== + [[gremlin-python-connecting]] === Connecting
