Skip to content

Commit

Permalink
Bump to version 3.0 (#495)
Browse files Browse the repository at this point in the history
* Bump to version 3.0

Signed-off-by: Xuanwo <github@xuanwo.io>

* Update changelog

Signed-off-by: Xuanwo <github@xuanwo.io>

* Update docs

Signed-off-by: Xuanwo <github@xuanwo.io>
  • Loading branch information
Xuanwo committed Jan 16, 2021
1 parent cfdfc21 commit 53c2f2c
Show file tree
Hide file tree
Showing 9 changed files with 49 additions and 33 deletions.
22 changes: 21 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

## [v3.0.0] - 2021-01-15

### Added

- pairs: Add support for user-agent (#477)
- operation: Add fetcher (#480)
- Proposal: Add default pair for operations (#484)
- types: Implement proposal Unify List Operation (#489)
- types: Implement proposal segment api redesign (#490)
- cmd: Implement code generate and format (#491)
- types: Implement proposal Object Mode (#493)

### Changed

- cmd/definitions: Don't need to store definitions to bindata (#476)
- cmd: Introduce aos-dev/specs to maintain specs (#481)
- docs: Migrate design to aos-dev/specs (#488)
- cmd: Migrate from hcl to toml (#496)

## [v2.0.0] - 2020-11-12

### Changed
Expand Down Expand Up @@ -390,7 +409,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
- Add pair based option and metadata support.
- Add qingstor services.

[Unreleased]: https://github.com/Xuanwo/storage/compare/v2.0.0...HEAD
[Unreleased]: https://github.com/Xuanwo/storage/compare/v3.0.0...HEAD
[v3.0.0]: https://github.com/Xuanwo/storage/compare/v2.0.0...v3.0.0
[v2.0.0]: https://github.com/Xuanwo/storage/compare/v2.0.0-beta...v2.0.0
[v2.0.0-beta]: https://github.com/Xuanwo/storage/compare/v2.0.0-alpha.1...v2.0.0-beta
[v2.0.0-alpha.1]: https://github.com/Xuanwo/storage/compare/v1.2.1...v2.0.0-alpha.1
Expand Down
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,30 +39,25 @@ An application-oriented unified storage layer for Golang.

Basic operations

- Metadata: get storager's metadata
- Metadata: get storager metadata
- Read: read file content
- Write: write content into file
- Stat: get file's metadata
- Delete: delete a file or directory
- List: list file in prefix or dir styles

Extended operations

- Copy: copy a file inside storager
- Move: move a file inside storager
- Reach: generate a public accessible url

Multiple list style support
Multi object modes support

- ListDir: list files and directories under a directory
- ListPrefix: list files under a prefix

Segment/Multipart support

- ListPrefixSegment: list segments under a prefix
- InitIndexSegment: initiate an index type segment
- WriteIndexSegment: write content into an index type segment
- CompleteSegment: complete a segment to create a file
- AbortSegment: abort a segment
- Multipart: allow doing multipart uploads
- Append: allow appending to an object
- Block: allow combining an object with block ids.
- Page: allow doing random writes

### Object metadata support

Expand All @@ -79,16 +74,17 @@ Optional metadata
- `content-md5`: md5 digest as defined in [rfc2616](https://tools.ietf.org/html/rfc2616#section-14.15)
- `content-type`: media type as defined in [rfc2616](https://tools.ietf.org/html/rfc2616#section-14.17)
- `etag`: entity tag as defined in [rfc2616](https://tools.ietf.org/html/rfc2616#section-14.19)
- `storage-class`: object's storage class as defined in [storage proposal](./docs/design/8-normalize-metadata-storage-class.md)
- `storage-class`: object's storage class as defined
in [storage proposal](./docs/design/8-normalize-metadata-storage-class.md)

## Quick Start

```go
import (
"log"

"github.com/aos-dev/go-storage/v2"
"github.com/aos-dev/go-storage/v2/pairs"
"github.com/aos-dev/go-storage/v3"
"github.com/aos-dev/go-storage/v3/pairs"
"github.com/aos-dev/go-services-fs"
)

Expand Down
10 changes: 5 additions & 5 deletions cmd/definitions/bindata.go

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions cmd/definitions/tmpl/pair.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ package pairs
import (
"context"

"github.com/aos-dev/go-storage/v2/pkg/httpclient"
. "github.com/aos-dev/go-storage/v2/types"
"github.com/aos-dev/go-storage/v3/pkg/httpclient"
. "github.com/aos-dev/go-storage/v3/types"

)

{{- range $_, $v := .Pairs }}
Expand Down
10 changes: 5 additions & 5 deletions cmd/definitions/tmpl/service.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import (
"context"
"io"

"github.com/aos-dev/go-storage/v2/pkg/endpoint"
"github.com/aos-dev/go-storage/v2/pkg/credential"
"github.com/aos-dev/go-storage/v2/pkg/httpclient"
"github.com/aos-dev/go-storage/v2/services"
. "github.com/aos-dev/go-storage/v2/types"
"github.com/aos-dev/go-storage/v3/pkg/endpoint"
"github.com/aos-dev/go-storage/v3/pkg/credential"
"github.com/aos-dev/go-storage/v3/pkg/httpclient"
"github.com/aos-dev/go-storage/v3/services"
. "github.com/aos-dev/go-storage/v3/types"
)

var _ credential.Provider
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/aos-dev/go-storage/v2
module github.com/aos-dev/go-storage/v3

go 1.14

Expand Down
1 change: 0 additions & 1 deletion go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
Expand Down
4 changes: 2 additions & 2 deletions pairs/generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion services/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"errors"
"fmt"

"github.com/aos-dev/go-storage/v2/types"
"github.com/aos-dev/go-storage/v3/types"
)

var (
Expand Down

0 comments on commit 53c2f2c

Please sign in to comment.