TinkerPop3

Documentation

• user documentation

• javadoc

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…​}

• Regenerate test data (only necessary given changes to IO classes): mvn clean install -Dio from tinkergraph-gremlin directory

• Build AsciiDocs: mvn process-resources -Dasciidoc

• Deploy AsciiDocs: mvn deploy -Dasciidoc

• Deploy JavaDocs: mvn deploy -Djavadoc

• Deploy Zip Archives: mvn deploy -Darchives

• Integration Tests: mvn clean verify -DskipIntegrationTests=false

• Performance Tests: mvn clean verify -DskipPerformanceTests=false

• Gatling Load Tests: mvn clean 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 assumes master branch

• Auto-Deploy to SNAPSHOT repository: push to master when version in pom.xml is marked -SNAPSHOT

Get Started

$ bin/gremlin.sh

         \,,,/
         (o o)
-----oOOo-(3)-oOOo-----
gremlin>

Release Process

1. mvn clean install

   1. mvn verify -DskipIntegrationTests=false

   2. mvn verify -DskipPerformanceTests=false

2. Update CHANGELOG.asciidoc with release date.

3. Updated pom.xml to reference the non-SNAPSHOT version.

4. Update all yaml files to reference the non-SNAPSHOT version.

5. git commit -a -m "TinkerPop x.y.z release" and git push

6. git tag -a -m "TinkerPop x.y.z release" x.y.z and git push --tags

7. mvn clean deploy -Psonatype-oss-release

8. Log into SonaType, close and then release the release.

9. mvn deploy -Darchives

10. bin/publish-docs.sh

11. Update S3 redirects for docs and download links on home page.

    1. s3cmd --acl-public put index.html s3://www.tinkerpop.com/

12. Email gremlin-users mailing list and tweet.