From aa477ece43fe32bedaac405bbf1428ca25a41b09 Mon Sep 17 00:00:00 2001 From: mstefaniak Date: Fri, 15 Jan 2021 14:48:12 +0100 Subject: [PATCH] Added build workflow and updated README + Changelog --- .github/workflows/build.yml | 30 ++++++++++++++++++++++++++++++ CHANGELOG.md | 6 ++++++ README.md | 14 ++++++++++++++ 3 files changed, 50 insertions(+) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..8d96168 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,30 @@ +name: Build + +on: + push: + branches: + - main + pull_request: + +jobs: + build: + name: Build + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + go: ["1.15", "1.14", "1.13"] + defaults: + run: + shell: bash + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup Go + uses: actions/setup-go@v1 + with: + go-version: ${{ matrix.go }} + - name: Build + run: make build + - name: Test + run: make test diff --git a/CHANGELOG.md b/CHANGELOG.md index c460f9c..1b78238 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.2.0 (January 15, 2020) + +ENHANCEMENTS: + +* setting up `EQUINIX_REST_LOG` environmental variable to `DEBUG` enables Resty debug logging + ## 1.1.0 (November 04, 2020) ENHANCEMENTS: diff --git a/README.md b/README.md index b3b216f..1faf480 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,13 @@ Equinix REST client written in Go. Implementation is based on [Resty client](https://github.com/go-resty/resty). +![Build Status](https://github.com/equinix/rest-go/workflows/Build/badge.svg) +[![Go Report Card](https://goreportcard.com/badge/github.com/equinix/rest-go)](https://goreportcard.com/report/github.com/equinix/rest-go) +[![GoDoc](https://godoc.org/github.com/equinix/rest-go?status.svg)](https://godoc.org/github.com/equinix/rest-go) +![GitHub](https://img.shields.io/github/license/equinix/rest-go) + +--- + ## Purpose Purpose of this module is to wrap Resty REST client with Equinix specific error handling. @@ -52,3 +59,10 @@ or [Network Edge Go client](https://github.com/equinix/ne-go). log.Printf("Got error: %s", err) } ``` + +## Debugging + +Debug logging comes from Resty client and logs request and response details to stderr. + +Such debug logging can be enabled by setting up `EQUINIX_REST_LOG` environmental +variable to `DEBUG`