A python library to initialise a repository.
This library,
- clones an existing repository
- adds the Play project with up to date dependencies
- commits and pushes the changes to Github
Run init-service --help for instructions.
This library requires,
- Python 3.9
- the
$WORKSPACEenvironment variable to be set - new repositories will be created in this directory - a github token with permissions to push to the repository that needs initialising
- poetry (
pip install poetry)
To install the dependencies run:
make init
Or if you have nix installed, you can just run nix-shell
pip install -i https://artefacts.tax.service.gov.uk/artifactory/api/pypi/pips/simple init-service
Create a frontend microservice like this:
init-service my-frontend-microservice FRONTEND --github-token <token>
Create a backend microservice like this:
init-service my-backend-microservice BACKEND --with-mongo --github-token <token>
In order to run the tests you will need pytest installed.
To run the tests run:
make test
You can generate a repository for inspection with:
init-service <repository-name> <type> --dry-run
The new repository will be created in $WORKSPACE/
You will then need to manually copy over the repository.yaml and
LICENSE file (public repositories only) from another HMRC repository.
For example,
init-service test-frontend FRONTEND
cp ../contact-frontend/LICENSE ../test-frontend
cp ../contact-frontend/repository.yaml ../test-frontend
cd ../test-frontend
sbt runThen navigate to http://localhost:9000/test-frontend
If you need to add a file that should only exist in a frontend or backend, but not both, add the
path to the file to templates/service/template/BACKEND.delete if frontend-specific or
templates/service/template/FRONTEND.delete if backend-specific.
Increment the version found in pyproject.toml and run:
make publish