client-sdk-go

README

Contents

1. Overview
   
2. Usage
   
3. Contributing
   3.1. Versioning
   3.2. Issue Reporting
   3.3. Testing
      3.3.1. Functional
      3.3.2. Performance
   3.4. Releasing
   

1. Overview

Reference Awakari SDK for a Golang client

2. Usage

See the int_test.go for the code example.

3. Contributing

3.1. Versioning

The library follows the semantic versioning. The single source of the version info is the git tag:

git describe --tags --abbrev=0

3.2. Issue Reporting

TODO

3.3. Testing

3.3.1. Functional

API_URI=api.local:443 \
CLIENT_CERT_PATH=test0.client0.crt \
CLIENT_PRIVATE_KEY_PATH=test0.client0.key \
SERVER_PUBLIC_KEY_PATH=ca.crt \
make test

3.3.2. Performance

TODO

3.4. Releasing

To release a new version (e.g. 1.2.3) it's enough to put a git tag:

git tag -v1.2.3
git push --tags

The corresponding CI job is started to build a docker image and push it with the specified tag (+latest).