TinkerPop3

Documentation

• user documentation

• core javadoc

• full 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…​} - 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 from tinkergraph-gremlin directory

• Build AsciiDocs: 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 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. bin/bump.sh "version" to update project files to reference the non-SNAPSHOT version.

4. git diff and review the updated files (expect all pom.xml files and this README)

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. bin/publish-docs.sh

8. mvn clean install -Dasciidoc -Djavadoc -Dmaven.test.skip=true - generate distributions for the release version with documentation included

9. mvn deploy -Psonatype-oss-release -Dmaven.test.skip=true

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

11. mvn deploy -Darchives -Dmaven.test.skip=true

12. Update download links on home page.

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

13. Email gremlin-users mailing list and tweet.