common-go

README

@barchart/common-go

A public library of shared GoLang utilities.

Overview

Features

• Parameters - Pattern for accepting program arguments (e.g. flags, environment, AWS Secrets Manager).
• Configuration - Pattern for storing configuration data (e.g. database connection).
• Usage - Utility to print usage (e.g. commands and arguments) for a program.
• Logger - Basic logging strategy.

Development

Install Dependencies

Run go mod download to install dependencies.

Run Unit Tests

Run make test-v to execute unit tests.

Release New Code

• Add a new file for release notes to the ./releases folder,
• Create a new tag, using the ./tag.sh script, and
• Create a GitHub Release, using the aforementioned release notes.

License

This software is provided under the MIT license.