README.adoc

Vavr Documentation

This is the source of the Vavr documentation.

Performing Updates

• Ensure ~/.gradle/gradle.properties exists with:

  githubUser=<GitHub user>
  githubPassword=<GitHub password>

• Update the version in gradle.properties. Please note that the version in the Maven section of getting_started.adoc currently has to be updated manually.

• Write documentation and test results with ./gradlew asciidoc. If the Vavr API has changed, some code example tests might fail.

• Then git commit, git push and ./gradlew publishGhPages

• Nowadays, githubPassword effectively means a token and not the actual password!