Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 2.77 KB

README.md

File metadata and controls

29 lines (18 loc) · 2.77 KB
Raw

VANotify Java client (fork of GOV.UK Notify Java client)

Use this client to send emails, text messages and letters using the VANotify API.

Useful links

Development

Install Maven to work with this code base. If you are not familiar with Maven, read through Maven in 5 Minutes. Also read Introduction to the Build Lifecycle.

For a more verbose description of the development process, read CONTRIBUTING.md.

Environment file

This repository contains unit and integration tests. The latter make API calls and presume certain environment variables. To set up your environment, copy .env.example to .env, and substitute templated values as appropriate. The example file assumes API's Development environment and that you are using a Unix-like operating system.

Activate the environment in Bash by running . .env.

Workflow

  1. Make your desired changes. This should include bumping the version number in the files pom.xml and application.properties, and it should include creating a new entry in CHANGELOG.md.
  2. Run mvn clean test to run unit tests. If any test fails, return to step 1.
  3. When all unit tests pass, run mvn clean install to execute all phases of the lifecycle other than deploying to Github. This includes running integration tests. Note that your environment must be properly configured at this point or you will get errors.
  4. The final step is to deploy the package to Github so other projects can depend on it. If you have not already created your local .m2/settings.xml file and Github access token, read Working with the Apache Maven registry. Then run mvn deploy, visit here, and ensure the displayed version reflects the version you created in step 1.