go-logger

This Go package is used to offer a unified logging interface among projects.

Documentation

There usage documentation in docs. Development documentation is in this file.

Development workflow

Validate

docker compose run --rm golang-devtools validate

Other targets

docker compose run --rm golang-devtools help

Mocks

To generate or update mocks use gomockhandler. gomockhandler is provided by golang-devtools.

Check mocks

docker compose run --rm golang-devtools gomockhandler -config ./gomockhandler.json check

Generate / Update mocks

docker compose run --rm golang-devtools gomockhandler -config ./gomockhandler.json mockgen

User documentation

User documentation is build using TechDocs and published to Inventory.

To list the commands available for the TechDocs image:

docker compose run --rm help

For more information see the TechDocs Engineering Image.

Documentation validation

To Validate changed documentation:

docker compose run --rm techdocs validate

To validate all documentation:

docker compose run --rm techdocs validate MARKDOWN_FILES=docs/

Documentation preview

To preview the documentation:

docker compose up techdocs