This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new 8aaac87a0c Modernized some references in the documentation CTR
8aaac87a0c is described below
commit 8aaac87a0c9241e9eb62a1a80ac3699c228943ad
Author: Stephen Mallette <[email protected]>
AuthorDate: Wed Mar 25 19:27:51 2026 +0000
Modernized some references in the documentation CTR
---
docs/src/dev/developer/contributing.asciidoc | 2 +-
.../dev/developer/development-environment.asciidoc | 63 +++++++++-------------
docs/src/dev/developer/for-committers.asciidoc | 19 +++----
docs/src/dev/developer/release.asciidoc | 4 --
docs/src/recipes/anti-patterns.asciidoc | 4 +-
5 files changed, 35 insertions(+), 57 deletions(-)
diff --git a/docs/src/dev/developer/contributing.asciidoc
b/docs/src/dev/developer/contributing.asciidoc
index 62592d9d32..cb3dbbf265 100644
--- a/docs/src/dev/developer/contributing.asciidoc
+++ b/docs/src/dev/developer/contributing.asciidoc
@@ -219,7 +219,7 @@ on the Apache TinkerPop repository.
.. Include a rough synopsis of how the changes were tested. This might be as
simple as "Ran mvn clean install to
success and performed manual testing in the Gremlin Console".
.. Include other descriptive elements about the change if they are not already
included in the JIRA ticket.
-.. Automated builds will occur with Travis. Please be sure that the pull
request passes those builds and
+.. Automated builds will occur with
link:https://github.com/apache/tinkerpop/actions[GitHub Actions]. Please be
sure that the pull request passes those builds and
correct them if there are problems.
Once the pull request has been placed it will go into *review*:
diff --git a/docs/src/dev/developer/development-environment.asciidoc
b/docs/src/dev/developer/development-environment.asciidoc
index 6ec8dc0585..9b5dd3d117 100644
--- a/docs/src/dev/developer/development-environment.asciidoc
+++ b/docs/src/dev/developer/development-environment.asciidoc
@@ -28,7 +28,7 @@ image:conspiracy.png[]
[[system-configuration]]
== System Configuration
-At a minimum, development of TinkerPop requires
link:https://openjdk.java.net/projects/jdk/11/[Java 11]. Since 3.7.0, you can
also build with
+At a minimum, development of TinkerPop requires
link:https://openjdk.java.net/projects/jdk/11/[Java 11] or
link:https://openjdk.org/projects/jdk/17/[Java 17]. Note, however, that there
are some issues with deep reflection
so there are `--add-opens` JVM options included in the pom files to enable
this to work. Maven (requiring a minimum of
link:https://maven.apache.org/download.cgi[Maven 3.5.3+]) is used as the
common build system, which even
@@ -41,9 +41,9 @@ of the project and those will go untested.
To gain the ability to execute all aspects of the TinkerPop build system,
other environmental configurations must be
established. Those prerequisites are defined in the following subsections.
-As of TinkerPop 3.5.5, environment configuration for Gremlin Language Variants
can be optional, as Docker becomes a
-system requirement to build and test GLVs inside of Maven. Please make sure
Docker is installed and running on your system.
-You will need to install both
link:https://docs.docker.com/engine/install/[Docker Engine] and
+Specific environmental configuration for Gremlin Language Variants can be
optional, as Docker becomes a
+system requirement to build and test GLVs inside of Maven. Please make sure
Docker is installed and running on your
+system. You will need to install both
link:https://docs.docker.com/engine/install/[Docker Engine] and
link:https://docs.docker.com/compose/install/[Docker Compose], which are
included in
link:https://docs.docker.com/desktop/[Docker Desktop].
@@ -85,9 +85,8 @@ and the basic Ivy configuration will look as follows:
<artifact
pattern="${user.home}/.groovy/grapes/[organisation]/[module]/[type]s/[artifact]-[revision](-[classifier]).[ext]"/>
</filesystem>
<ibiblio name="localm2" root="${user.home.url}/.m2/repository/"
checkmodified="true" changingPattern=".*" changingMatcher="regexp"
m2compatible="true"/>
- <ibiblio name="jcenter" root="https://jcenter.bintray.com/";
m2compatible="true"/>
<ibiblio name="ibiblio" m2compatible="true"/>
- <ibiblio name="apache-snapshots"
root="http://repository.apache.org/snapshots/"; m2compatible="true"/>
+ <ibiblio name="apache-snapshots"
root="https://repository.apache.org/snapshots/"; m2compatible="true"/>
</chain>
</resolvers>
</ivysettings>
@@ -237,29 +236,17 @@ The site will be generated to the `target/site/home`
directory.
[[python-environment]]
=== Python Environment
-As of TinkerPop 3.2.2, the build optionally requires
link:https://www.python.org/[Python] to build the `gremlin-python`
-module. If Python is not installed, TinkerPop will still build with Maven, but
native Python tests and
-Java tests that require Python code will be skipped. Developers should also
install link:https://pypi.python.org/pypi/pip[pip]
-and link:https://virtualenv.pypa.io/en/stable/[virtualenv] (version 15.0.2 -
older versions may cause build failures).
+`gremlin-python` uses Docker for all tests inside of Maven, so a local Python
installation is not required. Please
+make sure Docker is installed and running on your system.
-The build expects Python a `python3` installation which should be 3.5.3 or
better. Python also tests kerberos and
-therefore requires:
-
-[source,text]
-sudo apt install libkrb5-dev krb5-user
-
-As of TinkerPop 3.5.5, `gremlin-python` uses Docker for all tests inside of
Maven, and Python installation will not be required to
-run `gremlin-python` through Maven. Please make sure Docker is installed and
running on your system.
-
-Once the Python environment is established, the full building and testing of
`gremlin-python` may commence. It
-can be done manually from the command line with:
+The full building and testing of `gremlin-python` can be done from the command
line with:
[source,text]
mvn clean install -Pglv-python
-which enables the "glv-python" Maven profile or in a more automated fashion
simply add a `.glv` file to the root of the
-`gremlin-python` module which will signify to Maven that the environment is
Python-ready. The `.glv` file need not have
-any contents and is ignored by Git. A standard `mvn clean install` will then
build `gremlin-python` in full.
+which enables the "glv-python" Maven profile. Alternatively, add a `.glv` file
to the root of the `gremlin-python`
+module to signal to Maven that `gremlin-python` should always build in full.
The `.glv` file need not have any
+contents and is ignored by Git. A standard `mvn clean install` will then build
`gremlin-python` in full.
The `.glv` file in `gremlin-python` also activates the
"console-integration-tests" Maven profile to run gremlin-console
integration tests. Alternatively, this profile can be activated manually. Note
that unlike `gremlin-python` the tests
@@ -271,8 +258,6 @@ mvn clean install -pl gremlin-console
-DskipIntegrationTests=false
TIP: For those who do not have a full Maven environment, please see
<<docker-integration,this section>> for how Docker
can be used to help run tests.
-TIP: Consider use of link:https://realpython.com/intro-to-pyenv/[pyenv] to
better manage Python versions and environments.
-
See the <<release-environment,Release Environment>> section for more
information on release manager configurations.
[[dotnet-environment]]
@@ -282,8 +267,8 @@ The build optionally requires
link:https://dotnet.microsoft.com/download[.NET SD
`gremlin-dotnet` module. If .NET SDK is not installed, TinkerPop will still
build with Maven, but .NET projects
will be skipped.
-As of TinkerPop 3.5.5, `gremlin-dotnet` uses Docker for running all test
projects inside of Maven, and .NET SDK will not
-be required to run `gremlin-dotnet` tests through Maven. Please make sure
Docker is installed and running on your system.
+`gremlin-dotnet` uses Docker for running all test projects inside of Maven,
and .NET SDK will not be required to run
+`gremlin-dotnet` tests through Maven. Please make sure Docker is installed and
running on your system.
`gremlin-dotnet` can be built and tested from the command line with:
@@ -387,8 +372,8 @@ newgrp docker
sudo chmod 666 /var/run/docker.sock
----
-As of TinkerPop 3.5.5, a docker image of the Gremlin Server will be built
automatically with `mvn clean install`, which
-is use for GLV tests inside of Docker. To skip building this image, append the
`-DskipImageBuild` flag to Maven commands.
+A docker image of the Gremlin Server will be built automatically with `mvn
clean install`, which is use for GLV tests
+inside of Docker. To skip building this image, append the `-DskipImageBuild`
flag to Maven commands.
[[release-environment]]
=== Release Environment
@@ -517,7 +502,7 @@ The following commands are a mix of Maven flags and shell
scripts that handle di
Maven project list argument, e.g.:
+
----
-export
GREMLIN_TESTS='org.apache.tinkerpop.gremlin.process.traversal.step.map.PathTest$Traversals,org.apache.tinkerpop.gremlin.process.traversal.PathTest'
+export
GREMLIN_TESTS='org.apache.tinkerpop.gremlin.process.traversal.step.map.MatchTest$CountMatchTraversals'
mvn -Dmaven.javadoc.skip=true --projects tinkergraph-gremlin test
----
** Clean the `.groovy/grapes/org.apache.tinkerpop` directory on build: `mvn
clean install -DcleanGrapes`
@@ -540,8 +525,8 @@ mvn -Dmaven.javadoc.skip=true --projects
tinkergraph-gremlin test
* Check the effective `pom.xml`: `mvn -pl gremlin-python -Pglv-python
help:effective-pom -Doutput=withProfilePom.xml`
* Deploy JavaDocs/AsciiDocs: `bin/publish-docs.sh svn-username`
* Integration Tests: `mvn verify -DskipIntegrationTests=false`
-** Execute with the `-DincludeNeo4j` option to include neo4j-gremlin tests. As
of 3.7.0, transactional tests on Gremlin Server, Gremlin Driver,
-and GLVs will run automatically with integration tests against the
TinkerTransactionGraph.
+** Execute with the `-DincludeNeo4j` option to include neo4j-gremlin tests.
Transactional tests on Gremlin Server,
+Gremlin Driver, and GLVs will run automatically with integration tests against
the `TinkerTransactionGraph`.
** Execute with the `-DuseEpoll` option to try to use Netty native transport
(works on Linux, but will fallback to Java NIO on other OS).
* Benchmarks: `mvn verify -DskipBenchmarks=false`
** Reports are generated to the console and to
`gremlin-tools/gremlin-benchmark/target/reports/benchmark`.
@@ -777,13 +762,13 @@ for the non-JVM languages.
There are generally no complexities to running the debugger for any JVM-based
test in the repository, but the following
tips are helpful to know when doing so:
-* It is not possible to run the tests in `gremlin-test` without an `Graph`
implementation. For example, it is not
-possible to just right-click
`org.apache.tinkerpop.gremlin.process.traversal.step.filter.CoinTest` and then
select
-`Debug 'CoinTest'`. Instead, running that test would require opening
`tinkergraph-gremlin` and executing the
-`TinkerGraphProcessStandardTest` (as an example) which runs the full Gremlin
test suite to include `CoinTest`.
-* To run just `CoinTest`, set a `GREMLIN_TESTS` environment variable with the
fully qualified path name to the test
+* It is not possible to run the tests in `gremlin-test` without a `Graph`
implementation. For example, it is not
+possible to just right-click
`org.apache.tinkerpop.gremlin.process.traversal.step.map.MatchTest` and then
select
+`Debug 'MatchTest'`. Instead, running that test would require opening
`tinkergraph-gremlin` and executing the
+`TinkerGraphProcessStandardTest` (as an example) which runs the full Gremlin
test suite to include `MatchTest`.
+* To run just `MatchTest`, set a `GREMLIN_TESTS` environment variable with the
fully qualified path name to the test
configuration in Intellij. Note that the fully qualified test name is really
-`org.apache.tinkerpop.gremlin.process.traversal.step.filter.CoinTest$Traversals`.
+`org.apache.tinkerpop.gremlin.process.traversal.step.map.MatchTest$CountMatchTraversals`.
* Gherkin tests have a similar pattern in that they require a `Graph`
implementation to execute them. Therefore,
debugging entails going to `tinkergraph-gremlin` and running
`TinkerGraphFeatureTest` in the debugger.
* It is possible to filter the Gherkin tests by adding a system property to
the debug configuration that specifies the
diff --git a/docs/src/dev/developer/for-committers.asciidoc
b/docs/src/dev/developer/for-committers.asciidoc
index 9b59a81edd..d6aada0091 100644
--- a/docs/src/dev/developer/for-committers.asciidoc
+++ b/docs/src/dev/developer/for-committers.asciidoc
@@ -136,16 +136,10 @@ distinguished from other changes in the release notes.
TinkerPop has several release branches:
-* `3.0-dev` - 3.0.x (no longer maintained)
-* `3.1-dev` - 3.1.x (no longer maintained)
-* `3.2-dev` - 3.2.x (no longer maintained)
-* `3.3-dev` - 3.3.x (no longer maintained)
-* `3.4-dev` - 3.4.x (no longer maintained)
-* `3.5-dev` - 3.5.x (no longer maintained)
-* `3.6-dev` - 3.6.x (no longer maintained)
+* `3.0-dev` through `3.6-dev` (no longer maintained)
* `3.7-dev` - 3.7.x (non-breaking bug fixes and enhancements)
-* `3.8-dev` - 3.8.x (current development)
-* `master` - 4.x (future development)
+* `3.8-dev` - 3.8.x (current 3.x development)
+* `master` - 4.x (current development)
The branch description above that reads "non-breaking bug fixes and
enhancements" simply means that within that release
line (i.e. patch version) changes should not alter existing behavior,
introduce new APIs, change serialization formats,
@@ -468,8 +462,8 @@ And the traversal of
"""
----
-The traversal must be written so that it can be parsed by both
`gremlin-groovy` and `gremlin-language`. Using syntax
-particular to one but not the other may result in test execution errors.
+The traversal must be written so that it can be parsed by `gremlin-language`.
Using syntax incompatible with the
+grammar may result in test execution errors.
It will be the results of this traversal that end up being asserted by
Gherkin. When writing these test traversals,
be sure to always use the method and enum prefixes. For example, use
`__.out()` for an anonymous traversal rather
@@ -669,6 +663,9 @@ configured by `CucumberOptions` on "*FeatureTest" setups.
[[gremlin-socket-server-tests]]
=== Gremlin Socket Server Tests
+
+IMPORTANT: 4.0.0-beta.1 Release - Removes websockets. This section will be
updated as the new HTTP test server falls into place.
+
`gremlin-socket-server` is an included test server for driver tests which
require predefined server
behavior. Typically, this is to test scenarios such as the server closing the
connection or returning
an error code but other response behavior can be added as needed for tests.
diff --git a/docs/src/dev/developer/release.asciidoc
b/docs/src/dev/developer/release.asciidoc
index 43e0f4ffcb..78e11397e9 100644
--- a/docs/src/dev/developer/release.asciidoc
+++ b/docs/src/dev/developer/release.asciidoc
@@ -350,7 +350,6 @@ the help of a PMC member for those steps.
. Examine the `future.asciidoc` and update the "Roadmap" as needed.
. Update the version numbers in `pull_request_template.md`.
. Send email to advise that code freeze is lifted.
-. Consider the changes made to Gremlin and determine if the community needs to
organize a PR to
[DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gremlin)
to keep TypeScript up to date.
. 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.
. Update root-level GLV examples to use the new release version:
@@ -361,9 +360,6 @@ the help of a PMC member for those steps.
.. Update version numbers in `gremlin-examples/gremlin-go/go.mod` to reference
the new release version
.. Test that all root-level examples work correctly with the new published
versions
. 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 <<io,IO
Documentation and Testing Section>>
-
-Apache provides access to download statistics for release
link:https://logging1-he-de.apache.org/stats/[here].
[[email-templates]]
== Email Templates
diff --git a/docs/src/recipes/anti-patterns.asciidoc
b/docs/src/recipes/anti-patterns.asciidoc
index 6e6e42a0b4..1abaa7d7b2 100644
--- a/docs/src/recipes/anti-patterns.asciidoc
+++ b/docs/src/recipes/anti-patterns.asciidoc
@@ -230,8 +230,8 @@ g.V().has('person','name','marko') <2>
[[steps-instead-of-tokens]]
== Steps Instead of Tokens
-NOTE: As of 3.5.0, `ByModulatorOptimizationStrategy` is present to
automatically translate this anti-pattern to their
-more performant versions for most cases however, it is still best to write
Gremlin according to the contents that follow.
+NOTE: `ByModulatorOptimizationStrategy` is present to automatically translate
this anti-pattern to their more performant
+ versions for most cases however, it is still best to write Gremlin according
to the contents that follow.
When child traversals contain a single step, there's a good chance that the
step can be replaced with a token. These
tokens are translated into optimized traversals that execute much faster then
their step traversal pendants. A few
