Skip to content

Commit

Permalink
[doc] Add changelog for 0.0.9
Browse files Browse the repository at this point in the history
- update roadmap, move unfinished to 0.0.10
  • Loading branch information
at15 committed Dec 31, 2018
1 parent fd4886c commit 86998fd
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 23 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Changelog

## v0.0.9

[release](https://github.com/dyweb/gommon/releases/tag/0.0.9) [closed issues](https://github.com/dyweb/gommon/issues?q=is%3Aissue+milestone%3A0.0.9+is%3Aclosed)

New feature

- [#66](https://github.com/dyweb/gommon/issues/66) error inspection without checking string, based on [go 2 proposal](https://go.googlesource.com/proposal/+/master/design/go2draft-error-inspection.md)
- [#105](https://github.com/dyweb/gommon/issues/105) `gommon add-build-ignore` used for disable all the legacy packages

Partial

- [#74](https://github.com/dyweb/gommon/issues/74) created `go.mod` so gommon be used by the `replace` directive in other
go mod based projects, gommon itself is still using dep
- [#103](https://github.com/dyweb/gommon/issues/103) style guide, only covered general and is not well formatted

Removed package

- [#68](https://github.com/dyweb/gommon/issues/68) deprecate request package, use httpclient in [go.ice#37](https://github.com/dyweb/go.ice/issues/37)

## v0.0.8

[release](https://github.com/dyweb/gommon/releases/tag/0.0.8) [closed issues](https://github.com/dyweb/gommon/issues?q=is%3Aclosed+milestone%3A0.0.8)
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ help:
# -- build vars ---
PKGS =./errors/... ./generator/... ./log/... ./noodle/... ./structure/... ./util/...
PKGST =./cmd ./errors ./generator ./log ./noodle ./structure ./util
VERSION = 0.0.8
VERSION = 0.0.9
BUILD_COMMIT := $(shell git rev-parse HEAD)
BUILD_TIME := $(shell date +%Y-%m-%dT%H:%M:%S%z)
CURRENT_USER = $(USER)
Expand Down
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
[![Build Status](https://travis-ci.org/dyweb/gommon.svg?branch=master)](https://travis-ci.org/dyweb/gommon)
[![codecov](https://codecov.io/gh/dyweb/gommon/branch/master/graph/badge.svg)](https://codecov.io/gh/dyweb/gommon)
[![Go Report Card](https://goreportcard.com/badge/github.com/dyweb/gommon)](https://goreportcard.com/report/github.com/dyweb/gommon)
[![Sourcegraph](https://sourcegraph.com/github.com/dyweb/gommon/-/badge.svg)](https://sourcegraph.com/github.com/dyweb/gommon?badge)
[![](https://tokei.rs/b1/github/dyweb/gommon)](https://github.com/dyweb/gommon)
[![loc](https://tokei.rs/b1/github/dyweb/gommon)](https://github.com/dyweb/gommon)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdyweb%2Fgommon.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdyweb%2Fgommon?ref=badge_shield)

Gommon is a collection of common util libraries written in Go.
Expand All @@ -27,15 +26,12 @@ It has the following components:
- [structure](structure) data structure like Set etc. to go
- [util](util) small utils over standard libraries utils

Deprecating

- [requests](requests) A pythonic wrapper for `net/http`, HTTP for Gopher

Legacy

- [config v1](config) A YAML config reader with template support
- [log v1](legacy/log) A logrus like structured logger
- [Runner](legacy/runner) A os/exec wrapper
- [runner](legacy/runner) A os/exec wrapper
- [requests](requests) A pythonic wrapper for `net/http`, HTTP for Gopher

## Dependencies

Expand All @@ -48,15 +44,14 @@ Currently we only have one non standard library dependencies (cmd and examples a

Removed

- [pkg/errors](https://github.com/pkg/errors) for including context in error
- removed in [#59](https://github.com/dyweb/gommon/pull/59)
- replaced by `gommon/errors`
- [pkg/errors](https://github.com/pkg/errors) for including context in error, removed in [#59](https://github.com/dyweb/gommon/pull/59)
replaced by `gommon/errors`

## Development

- install go https://golang.org/
- install dep https://github.com/golang/dep
- `dep ensure`
- `make dep-install`
- `make test`

## License
Expand Down
25 changes: 14 additions & 11 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,33 @@

## Up coming

### 0.0.9
### 0.0.10

From 0.0.9

- [ ] more complex error interface, error code
- [ ] error code
- [ ] organized error types
- [ ] explain internals of some implementation
- [ ] start documenting the style for writing gommon itself, lib using gommon, app using gommon/lib using gommon
- [ ] improve Makefile and dockerized build & test
- [ ] (optional) extension for collecting errors using third party services

Optional

- [ ] extension for collecting errors using third party services

### 0.0.10
New

- [ ] support better logging for errors
- [ ] init go mod support, not sure if it will be compatible with dep

### 0.0.11

- [ ] httputil package, merge part of current requests package unix domain sock etc.
- [ ] requests, download and upload file, a curl like example

## Finished

### 0.0.9

- [x] more complex error interface
- [x] start documenting the style for writing gommon itself, lib using gommon, app using gommon/lib using gommon
- [x] improve Makefile and dockerized build & test
- [x] init go mod
- [x] httputil package, merge part of current requests package unix domain sock etc.

### 0.0.8

- [x] test coverage for multiple packages
Expand Down

0 comments on commit 86998fd

Please sign in to comment.