development.md

go-logging development

The following instructions are useful during development.

Note: This has been tested on Linux and Darwin/macOS. It has not been tested on Windows.

Prerequisites for development

🤔 The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.

1. The following software programs need to be installed:
   1. git
   2. make
   3. go

Install Git repository

1. Identify git repository.

   export GIT_ACCOUNT=senzing-garage
   export GIT_REPOSITORY=go-logging
   export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
   export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
   

2. Using the environment variables values just set, follow steps in clone-repository to install the Git repository.

Dependencies

1. A one-time command to install dependencies needed for make targets. Example:

   cd ${GIT_REPOSITORY_DIR}
   make dependencies-for-development
   

2. Install dependencies needed for Go code. Example:

   cd ${GIT_REPOSITORY_DIR}
   make dependencies
   

Lint

1. Run linting. Example:

   cd ${GIT_REPOSITORY_DIR}
   make lint
   

Build

1. Build the binaries. Example:

   cd ${GIT_REPOSITORY_DIR}
   make clean build
   

2. The binaries will be found in the ${GIT_REPOSITORY_DIR}/target directory. Example:

   tree ${GIT_REPOSITORY_DIR}/target
   

Run

1. Run program. Examples:

   1. Linux

      ${GIT_REPOSITORY_DIR}/target/linux-amd64/go-logging
      

   2. macOS

      ${GIT_REPOSITORY_DIR}/target/darwin-amd64/go-logging
      

   3. Windows

      ${GIT_REPOSITORY_DIR}/target/windows-amd64/go-logging
      

2. Clean up. Example:

   cd ${GIT_REPOSITORY_DIR}
   make clean
   

Test

1. Run tests. Example:

   cd ${GIT_REPOSITORY_DIR}
   make clean setup test
   

Coverage

Create a code coverage map.

1. Run Go tests. Example:

   cd ${GIT_REPOSITORY_DIR}
   make clean setup coverage
   

   A web-browser will show the results of the coverage. The goal is to have over 80% coverage. Anything less needs to be reflected in testcoverage.yaml.

Documentation

1. View documentation. Example:

   cd ${GIT_REPOSITORY_DIR}
   make clean documentation
   

2. If a web page doesn't appear, visit localhost:6060.

3. Senzing documentation will be in the "Third party" section. github.com > senzing-garage > go-logging

4. When a versioned release is published with a v0.0.0 format tag, the reference can be found by clicking on the following badge at the top of the README.md page. Example:

   

5. To stop the godoc server, run

   cd ${GIT_REPOSITORY_DIR}
   make clean
   

References