shareddiscovery

Shared Discovery

A library for shared code in the Discovery Service.

API Documentation

Contributing

To contribute, you will need:

• go >= 1.17
• gopages for generating documentation

Create a feature branch from main and make your changes updates. Be sure to follow documentation standards when writing public functions and types and provide examples where applicable.

Make sure to run make docgen to update the documentation files.

Make tasks

• make test runs unit tests
• make mockgen builds mocks needed for testing

Once you feel good about your change and get it merged to main, you'll want to create a new release. Please follow semantic versioning as you release this library.

Installation

Since this is a private repository, you'll need a new environment variable called GOPRIVATE which you'll need to set to this repo. Put this in your .bashrc or .zshrc file:

export GOPRIVATE="github.com/pgdevelopers"

Now you should be able to run go get github.com/pgdevelopers/shareddiscovery to install this package in your project.

Usage

See the docs for complete API documentation.

Basic usage

  import (
    "github.com/pgdevelopers/shareddiscovery"
    "github.com/aws/aws-sdk-go/aws/session"
	  "github.com/aws/aws-sdk-go/service/dynamodb"
  )

  var discovery shareddiscovery.IFace

  func main() {
    query := QueryInput{Workspace: "tableName"}
    discovery.GetConfig(context.Background(), "someApiToken", query)
  }

  func init() {
    // setup AWS Session
    session := session.New()

    // setup DynamoDB
    dynamo := dynamodb.New(session)

    // setup shareddiscovery now
    discovery = shareddiscovery.New(dynamo)
  }

Testing

Provided is an interface that can be used with gomock to generate a mock for testing with. See the discovery service for more examples of testing with this library.