TinkerPop3
Documentation
Building and Testing
-
Build Project:
mvn clean install
-
Specify specific tests in a TinkerPop Suite to run:
mvn test -Dgremlin.tests={test class 1, test class 2…}
- note that including a specific test may require its inner class implementation (e.g.com.tinkerpop.gremlin….UnionTest$ComputerTest
) -
Fast-build (does not run
neo4j-gremlin
tests - use with caution):mvn clean install -DfeelingLucky
-
Clean the
.groovy/grapes/com.tinkerpop
directory on build:mvn clean install -DcleanGrapes
-
-
Regenerate test data (only necessary given changes to IO classes):
mvn clean install -Dio
fromtinkergraph-gremlin
directory -
Build AsciiDocs:
docs/preprocessor/preprocess.sh && mvn process-resources -Dasciidoc
-
Build JavaDocs:
mvn process-resources -Djavadoc
-
Deploy AsciiDocs:
mvn deploy -Dasciidoc
-
Deploy JavaDocs:
mvn deploy -Djavadoc
-
Deploy Zip Archives:
mvn deploy -Darchives
-
Integration Tests:
mvn verify -DskipIntegrationTests=false
-
Performance Tests:
mvn verify -DskipPerformanceTests=false
-
Gatling Load Tests:
mvn test -Pgatling -Dhost={hostname}
Travis Automation
-
Auto-Deploy Docs: merge/push to
publish-docs
branch-
bin/publish-docs.sh
is a doc deployment script which assumesmaster
branch
-
-
Auto-Deploy to SNAPSHOT repository: push to
master
when version inpom.xml
is marked-SNAPSHOT
Get Started
$ bin/gremlin.sh
\,,,/
(o o)
-----oOOo-(3)-oOOo-----
gremlin>
Release Process
-
mvn clean install
-
mvn verify -DskipIntegrationTests=false
-
mvn verify -DskipPerformanceTests=false
-
-
Update
CHANGELOG.asciidoc
with release date. -
bin/bump.sh "version"
to update project files to reference the non-SNAPSHOT version. -
git diff
and review the updated files (expect allpom.xml
files and this README) -
git commit -a -m "TinkerPop x.y.z release"
andgit push
-
git tag -a -m "TinkerPop x.y.z release" x.y.z
andgit push --tags
-
bin/publish-docs.sh
-
mvn clean install -Dasciidoc -Djavadoc -Dmaven.test.skip=true
- generate distributions for the release version with documentation included -
mvn deploy -Psonatype-oss-release -Dmaven.test.skip=true
-
Log into SonaType, close and then release the release.
-
mvn deploy -Darchives -Dmaven.test.skip=true
-
Update download links on home page.
-
s3cmd --acl-public put index.html s3://www.tinkerpop.com/
-
-
Email gremlin-users mailing list and tweet.