Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 2.95 KB

Development.md

File metadata and controls

98 lines (69 loc) · 2.95 KB
Raw

Development and Testing Guide
Pip.Services Remote Procedure Calls for Golang

This document provides high-level instructions on how to build and test the microservice.

Environment Setup

This is a Golang project and you have to install Golang tools. You can download them from official Golang website: https://golang.org/dl/

After go is installed you can check it by running the following command:

go version

To work with GitHub code repository you need to install Git from: https://git-scm.com/downloads

Installing

After your environment is ready you can check out source code from the Github repository:

git clone git@github.com:pip-services/pip-services-rpc-go.git

If you worked with the microservice before you can check out latest changes and update the dependencies:

Update source code updates from github

go get -u

Building

The commons is written in Golang language. So, if you make changes to the source code you need to compile it before running or committing to github. The process will output compiled executable files.

go build

Testing

Before you execute tests you need to set configuration options in config.yaml file. As a starting point you can use example from config.example.json:

copy config/config.example.yaml config/config.yaml

After that check all configuration options. Specifically, pay attention to connection options for database and dependent microservices. For more information check Configuration Guide

Command to run unit tests and benchmarks as:

go test ./test/...

Release

Formal release process consistents of few steps. First of all it is required to tag guthub repository with a version number:

git commit -m "Emphasize our friendliness" testmod.go
git tag v1.0.1
git push --tags origin v1

Microservice releases additionally require generation and publishing binary packages at http://downloads.pipservices.org

Contributing

Developers interested in contributing should read the following instructions:

Please do not ask general questions in an issue. Issues are only to report bugs, request enhancements, or request new features. For general questions and discussions, use the Contributors Forum.

It is important to note that for each release, the ChangeLog is a resource that will itemize all:

  • Bug Fixes
  • New Features
  • Breaking Changes