DEFRA / sroc-service-team

Guides, info and issue management for the Charging Module Team
Other
0 stars 1 forks source link

Add notes about docker hub integration #46

Closed Cruikshanks closed 3 years ago

Cruikshanks commented 3 years ago

https://trello.com/c/jHORNdnQ

We have now made version 2 available as a docker image in Docker Hub. As part of that, we have produced a guide on how to get started, along with an example docker-compose.yml and makefile.

Normally, this information would all be added to the README on docker hub. But we have also enabled automated builds. This means you can always grab whatever is on main as a docker image plus whenever we add a tag docker hub automatically builds a matching image. Sweet!

The downside is the standard behaviour of an automated build is to overwrite the README in docker hub with the one from the source repo! 😩🤦

So, at some point, we'll want to update the API read me to make sense in both contexts. But for now, it also means we need a place to store details about the integration plus the guide and example files we have produced.

This change covers adding all that here.