Skip to content

Commit

Permalink
Added build workflow and updated README + Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
mikouaj committed Jan 15, 2021
1 parent 09ec622 commit aa477ec
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`

0 comments on commit aa477ec

Please sign in to comment.