utils-go

This module contains common functions and types that have utility across tozny golang based repositories.

Build

To "build" this module, type

make lint

this will run the go psuedo-compiler and linter tool vet, along with the mod tool to handle golang source code dependency management.

Development

Checkout branch to work on. Write code on that branch. Make a commit on that branch. Push branch & commit. From other repository that depends on this module, fetch the committed changes by running

go get github.com/tozny/utils-go@GITCOMMITSHA

Iterate on committed changes from within dependent repository.

Publishing

Follow semantic versioning when releasing new versions of this library.

Releasing involves tagging a commit in this repository, and pushing the tag. Tagging and releasing of new versions should only be done from the master branch after an approved Pull Request has been merged, or on the branch of an approved Pull Request.

To publish a new version, run

git tag vX.Y.Z
git push origin vX.Y.Z

or using the make version command

make version version=X.Y.Z

To consume published updates from other repositories that depends on this module run

go get github.com/tozny/[email protected]

and the go get tool will fetch the published artifact and update that modules go.mod andgo.sum files with the updated dependency. Currently the list of modules that depend on this module are

• Search Service (Private)
• Hook Service (Private)
• Storage Service (Private)
• Billing Service (Private)
• Cyclops (Private)
• Client Service (Private)
• Metrics Service (Private)
• Identity Management Service (Private)