Release infrastructure (#61)

* build(scripts): add imports + release scripts * style(imports): fix import style use standard import style via script * ci(circle): add imports-check, cbor-gen-check * docs(CHANGELOG): add changelog with releases record
filecoin-project · Aug 4, 2020 · 50fb041 · 50fb041
1 parent 3cb77ab
commit 50fb041
Show file tree

Hide file tree

Showing 32 changed files with 571 additions and 60 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -37,6 +37,27 @@ jobs:
       - prepare
       - go/mod-download
       - go/mod-tidy-check
+
+  imports-check:
+    executor: golang
+    steps:
+      - install-deps
+      - prepare
+      - run: go install golang.org/x/tools/cmd/goimports
+      - run: scripts/fiximports
+      - run: git --no-pager diff
+      - run: git --no-pager diff --quiet
+
+  cbor-gen-check:
+    executor: golang
+    steps:
+      - install-deps
+      - prepare
+      - run: go install golang.org/x/tools/cmd/goimports
+      - run: go install github.com/hannahhoward/cbor-gen-for
+      - run: go generate ./...
+      - run: git --no-pager diff
+      - run: git --no-pager diff --quiet
 
   test: &test
     description: |
@@ -159,3 +180,5 @@ workflows:
           args: "--new-from-rev origin/master"
       - test
       - mod-tidy-check
+      - cbor-gen-check
+      - imports-check
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,195 @@
+# go-data-transfer changelog
+
+# go-data-transfer 0.2.0
+
+Initial extracted release for Testnet Phase 2 (v0.1.0 + v0.1.1 were lotus tags prior to extraction)
+
+### Changelog
+
+- github.com/filecoin-project/go-data-transfer:
+  - Upgrade graphsync + ipld-prime (#49) ([filecoin-project/go-data-transfer#49](https://github.com/filecoin-project/go-data-transfer/pull/49))
+  - Use extracted generic pubsub (#48) ([filecoin-project/go-data-transfer#48](https://github.com/filecoin-project/go-data-transfer/pull/48))
+  - Refactor & Cleanup In Preparation For Added Complexity (#47) ([filecoin-project/go-data-transfer#47](https://github.com/filecoin-project/go-data-transfer/pull/47))
+  - feat(graphsync): complete notifications for responder (#46) ([filecoin-project/go-data-transfer#46](https://github.com/filecoin-project/go-data-transfer/pull/46))
+  - Update graphsync ([filecoin-project/go-data-transfer#45](https://github.com/filecoin-project/go-data-transfer/pull/45))
+  - docs(docs): remove outdated docs
+  - docs(README): clean up README
+  - docs(license): add license + contrib
+  - ci(circle): add config
+  - build(datatransfer): add go.mod
+  - build(cbor-gen): add tools for cbor-gen-for .
+  - fix links in datatransfer README (#11) ([filecoin-project/go-data-transfer#11](https://github.com/filecoin-project/go-data-transfer/pull/11))
+  - feat(shared): add shared tools and types (#9) ([filecoin-project/go-data-transfer#9](https://github.com/filecoin-project/go-data-transfer/pull/9))
+  - Feat/datatransfer readme, contributing, design doc (rename)
+  - refactor(datatransfer): move to local module
+  - feat(datatransfer): switch to graphsync implementation
+  - Don't respond with error in gsReqRcdHook when we can't find the datatransfer extension. (#754) ([filecoin-project/go-data-transfer#754](https://github.com/filecoin-project/go-data-transfer/pull/754))
+  - Feat/dt subscribe, file Xfer round trip (#720) ([filecoin-project/go-data-transfer#720](https://github.com/filecoin-project/go-data-transfer/pull/720))
+  - Feat/dt gs pullrequests (#693) ([filecoin-project/go-data-transfer#693](https://github.com/filecoin-project/go-data-transfer/pull/693))
+  - DTM sends data over graphsync for validated push requests (#665) ([filecoin-project/go-data-transfer#665](https://github.com/filecoin-project/go-data-transfer/pull/665))
+  - Techdebt/dt split graphsync impl receiver (#651) ([filecoin-project/go-data-transfer#651](https://github.com/filecoin-project/go-data-transfer/pull/651))
+  - Feat/dt initiator cleanup (#645) ([filecoin-project/go-data-transfer#645](https://github.com/filecoin-project/go-data-transfer/pull/645))
+  - Feat/dt graphsync pullreqs (#627) ([filecoin-project/go-data-transfer#627](https://github.com/filecoin-project/go-data-transfer/pull/627))
+  - fix(datatransfer): fix tests
+  - Graphsync response is scheduled when a valid push request is received (#625) ([filecoin-project/go-data-transfer#625](https://github.com/filecoin-project/go-data-transfer/pull/625))
+  - responses alert subscribers when request is not accepted (#607) ([filecoin-project/go-data-transfer#607](https://github.com/filecoin-project/go-data-transfer/pull/607))
+  - feat(datatransfer): milestone 2 infrastructure
+  - other tests passing
+  - send data transfer response
+  - a better reflection
+  - remove unused fmt import in graphsync_test
+  - cleanup for PR
+  - tests passing
+  - Initiate push and pull requests (#536) ([filecoin-project/go-data-transfer#536](https://github.com/filecoin-project/go-data-transfer/pull/536))
+  - Fix tests
+  - Respond to PR comments: * Make DataTransferRequest/Response be returned in from Net * Regenerate cbor_gen and fix the generator caller so it works better * Please the linters
+  - Cleanup for PR, clarifying and additional comments
+  - Some cleanup for PR
+  - all message tests passing, some others in datatransfer
+  - WIP trying out some stuff * Embed request/response in message so all the interfaces work AND the CBOR unmarshaling works: this is more like the spec anyway * get rid of pb stuff
+  - * Bring cbor-gen stuff into datatransfer package * make transferRequest private struct * add transferResponse + funcs * Rename VoucherID to VoucherType * more tests passing
+  - WIP using CBOR encoding for dataxfermsg
+  - feat(datatransfer): setup implementation path
+  - Duplicate comment ([filecoin-project/go-data-transfer#619](https://github.com/filecoin-project/go-data-transfer/pull/619))
+  - fix typo ([filecoin-project/go-data-transfer#621](https://github.com/filecoin-project/go-data-transfer/pull/621))
+  - fix types typo
+  - refactor(datatransfer): implement style fixes
+  - refactor(deals): move type instantiation to modules
+  - refactor(datatransfer): xerrors, cbor-gen, tweaks
+  - feat(datatransfer): make dag service dt async
+  - refactor(datatransfer): add comments, renames
+  - feat(datatransfer): integration w/ simple merkledag
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Shannon Wells | 12 | +4337/-3455 | 53 |
+| hannahhoward | 20 | +5090/-1692 | 99 |
+| shannonwells | 13 | +1720/-983 | 65 |
+| Hannah Howard | 6 | +1393/-1262 | 45 |
+| wanghui | 2 | +4/-4 | 2 |
+| 郭光华 | 1 | +0/-1 | 1 |
+
+# go-data-transfer 0.2.1
+
+Bug fix release -- critical nil check
+
+### Changelog
+
+- github.com/filecoin-project/go-data-transfer:
+  - chore(deps): update graphsync
+- github.com/ipfs/go-graphsync (v0.0.6-0.20200428204348-97a8cf76a482 -> v0.0.6-0.20200504202014-9d5f2c26a103):
+  - fix(responsemanager): add nil check (#67) ([ipfs/go-graphsync#67](https://github.com/ipfs/go-graphsync/pull/67))
+  - Add autocomment configuration
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Hector Sanjuan | 1 | +68/-0 | 1 |
+| hannahhoward | 1 | +3/-3 | 2 |
+| Hannah Howard | 1 | +4/-0 | 1 |
+
+# go-data-transfer 0.3.0
+
+Additional refactors to refactors to registry
+
+### Changelog 
+- github.com/filecoin-project/go-data-transfer:
+  - feat(graphsyncimpl): fix open/close events (#52) ([filecoin-project/go-data-transfer#52](https://github.com/filecoin-project/go-data-transfer/pull/52))
+  - chore(deps): update graphsync ([filecoin-project/go-data-transfer#51](https://github.com/filecoin-project/go-data-transfer/pull/51))
+  - Refactor registry and encoding (#50) ([filecoin-project/go-data-transfer#50](https://github.com/filecoin-project/go-data-transfer/pull/50))
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Hannah Howard | 2 | +993/-496 | 30 |
+
+# go-data-transfer 0.4.0
+
+Major rewrite of library -- transports, persisted state, revalidators, etc. To support retrieval
+
+### Changelog
+
+- github.com/filecoin-project/go-data-transfer:
+  - The new data transfer (#55) ([filecoin-project/go-data-transfer#55](https://github.com/filecoin-project/go-data-transfer/pull/55))
+  - Actually track progress for send/receive (#53) ([filecoin-project/go-data-transfer#53](https://github.com/filecoin-project/go-data-transfer/pull/53))
+- github.com/ipfs/go-graphsync (v0.0.6-0.20200504202014-9d5f2c26a103 -> v0.0.6-0.20200708073926-caa872f68b2c):
+  - All changes to date including pause requests & start paused, along with new adds for cleanups and checking of execution (#75) ([ipfs/go-graphsync#75](https://github.com/ipfs/go-graphsync/pull/75))
+  - More fine grained response controls (#71) ([ipfs/go-graphsync#71](https://github.com/ipfs/go-graphsync/pull/71))
+  - Refactor request execution and use IPLD SkipMe functionality for proper partial results on a request (#70) ([ipfs/go-graphsync#70](https://github.com/ipfs/go-graphsync/pull/70))
+  - feat(graphsync): implement do-no-send-cids extension (#69) ([ipfs/go-graphsync#69](https://github.com/ipfs/go-graphsync/pull/69))
+  - Incoming Block Hooks (#68) ([ipfs/go-graphsync#68](https://github.com/ipfs/go-graphsync/pull/68))
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Hannah Howard | 7 | +12381/-4583 | 133 |
+
+# go-data-transfer 0.5.0
+
+Additional changes to support implementation of retrieval on top of go-data-transfer
+
+### Changelog
+
+- github.com/filecoin-project/go-data-transfer:
+  - Minor fixes for retrieval on data transfer (#56) ([filecoin-project/go-data-transfer#56](https://github.com/filecoin-project/go-data-transfer/pull/56))
+- github.com/ipfs/go-graphsync (v0.0.6-0.20200708073926-caa872f68b2c -> v0.0.6-0.20200715204712-ef06b3d32e83):
+  - feat(requestmanager): run response hooks on completed requests (#77) ([ipfs/go-graphsync#77](https://github.com/ipfs/go-graphsync/pull/77))
+  - Revert "add extensions on complete (#76)"
+  - add extensions on complete (#76) ([ipfs/go-graphsync#76](https://github.com/ipfs/go-graphsync/pull/76))
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Hannah Howard | 3 | +515/-218 | 26 |
+| hannahhoward | 1 | +155/-270 | 9 |
+
+# go-data-transfer v0.5.1
+
+Support custom configruation of transports
+
+### Changelog
+
+- github.com/filecoin-project/go-data-transfer:
+  - Allow custom configuration of transports (#57) ([filecoin-project/go-data-transfer#57](https://github.com/filecoin-project/go-data-transfer/pull/57))
+- github.com/ipfs/go-graphsync (v0.0.6-0.20200715204712-ef06b3d32e83 -> v0.0.6-0.20200721211002-c376cbe14c0a):
+  - feat(persistenceoptions): add unregister ability
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Hannah Howard | 1 | +1049/-751 | 35 |
+| hannahhoward | 1 | +113/-32 | 5 |
+
+# go-data-transfer 0.5.2
+
+Security fix release
+
+### Changelog
+
+- github.com/filecoin-project/go-data-transfer:
+  - fix(deps): update graphsync
+  - fix(message): add error check to FromNet (#59) ([filecoin-project/go-data-transfer#59](https://github.com/filecoin-project/go-data-transfer/pull/59))
+- github.com/ipfs/go-graphsync (v0.0.6-0.20200721211002-c376cbe14c0a -> v0.0.6-0.20200731020347-9ff2ade94aa4):
+  - feat(persistenceoptions): add unregister ability (#80) ([ipfs/go-graphsync#80](https://github.com/ipfs/go-graphsync/pull/80))
+  - fix(message): regen protobuf code (#79) ([ipfs/go-graphsync#79](https://github.com/ipfs/go-graphsync/pull/79))
+
+### Contributors
+
+| Contributor | Commits | Lines ± | Files Changed |
+|-------------|---------|---------|---------------|
+| Hannah Howard | 3 | +442/-302 | 7 |
+| hannahhoward | 1 | +3/-3 | 2 |
+
+### 🙌🏽 Want to contribute?
+
+Would you like to contribute to this repo and don’t know how? Here are a few places you can get started:
+
+- Check out the [Contributing Guidelines](https://github.com/filecoin-project/go-data-transfer/blob/master/CONTRIBUTING.md)
+- Look for issues with the `good-first-issue` label in [go-fil-markets](https://github.com/filecoin-project/go-data-transfer/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22e-good-first-issue%22+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -38,6 +38,8 @@ import (
         <single, empty line>
         [external packages]
         <single, empty line>
+        [other-filecoin-project packages]
+        <single, empty line>
         [go-data-transfer packages]
 )
 ```
@@ -55,10 +57,14 @@ import (
 	"github.com/ipfs/go-cid"
 	cborgen "github.com/whyrusleeping/cbor-gen"
 
-	"github.com/filecoin-project/go-data-transfer"
+        "github.com/filecoin-project/go-statemachine"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
 )
 ```
 
+You can run `script/fiximports` to put all your code in the desired format
+
 #### Comments
 Comments are a communication to other developers (including your future self) to help them understand and maintain code. Good comments describe the _intent_ of the code, without repeating the procedures directly.
 

diff --git a/channels/channel_state.go b/channels/channel_state.go
@@ -3,13 +3,14 @@ package channels
 import (
 	"bytes"
 
-	datatransfer "github.com/filecoin-project/go-data-transfer"
 	"github.com/ipfs/go-cid"
 	"github.com/ipld/go-ipld-prime"
 	"github.com/ipld/go-ipld-prime/codec/dagcbor"
 	basicnode "github.com/ipld/go-ipld-prime/node/basic"
 	peer "github.com/libp2p/go-libp2p-core/peer"
 	cbg "github.com/whyrusleeping/cbor-gen"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
 )
 
 // channelState is immutable channel data plus mutable state

diff --git a/channels/channels.go b/channels/channels.go
@@ -5,14 +5,16 @@ import (
 	"errors"
 	"time"
 
-	datatransfer "github.com/filecoin-project/go-data-transfer"
-	"github.com/filecoin-project/go-data-transfer/encoding"
-	"github.com/filecoin-project/go-statemachine/fsm"
 	"github.com/ipfs/go-cid"
 	"github.com/ipfs/go-datastore"
 	"github.com/ipld/go-ipld-prime"
 	peer "github.com/libp2p/go-libp2p-core/peer"
 	cbg "github.com/whyrusleeping/cbor-gen"
+
+	"github.com/filecoin-project/go-statemachine/fsm"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
+	"github.com/filecoin-project/go-data-transfer/encoding"
 )
 
 type DecoderByTypeFunc func(identifier datatransfer.TypeIdentifier) (encoding.Decoder, bool)

diff --git a/channels/channels_fsm.go b/channels/channels_fsm.go
@@ -1,10 +1,12 @@
 package channels
 
 import (
-	datatransfer "github.com/filecoin-project/go-data-transfer"
-	"github.com/filecoin-project/go-statemachine/fsm"
 	logging "github.com/ipfs/go-log"
 	cbg "github.com/whyrusleeping/cbor-gen"
+
+	"github.com/filecoin-project/go-statemachine/fsm"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
 )
 
 var log = logging.Logger("data-transfer")

diff --git a/channels/channels_test.go b/channels/channels_test.go
@@ -6,15 +6,16 @@ import (
 	"testing"
 	"time"
 
-	datatransfer "github.com/filecoin-project/go-data-transfer"
-	"github.com/filecoin-project/go-data-transfer/channels"
-	"github.com/filecoin-project/go-data-transfer/encoding"
-	"github.com/filecoin-project/go-data-transfer/testutil"
 	"github.com/ipfs/go-datastore"
 	basicnode "github.com/ipld/go-ipld-prime/node/basic"
 	"github.com/ipld/go-ipld-prime/traversal/selector/builder"
 	peer "github.com/libp2p/go-libp2p-core/peer"
 	"github.com/stretchr/testify/require"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
+	"github.com/filecoin-project/go-data-transfer/channels"
+	"github.com/filecoin-project/go-data-transfer/encoding"
+	"github.com/filecoin-project/go-data-transfer/testutil"
 )
 
 func TestChannels(t *testing.T) {

diff --git a/channels/internalchannel.go b/channels/internalchannel.go
@@ -1,10 +1,11 @@
 package channels
 
 import (
-	datatransfer "github.com/filecoin-project/go-data-transfer"
 	"github.com/ipfs/go-cid"
 	peer "github.com/libp2p/go-libp2p-core/peer"
 	cbg "github.com/whyrusleeping/cbor-gen"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
 )
 
 //go:generate cbor-gen-for internalChannelState encodedVoucher encodedVoucherResult

diff --git a/impl/environment.go b/impl/environment.go
@@ -1,8 +1,9 @@
 package impl
 
 import (
-	datatransfer "github.com/filecoin-project/go-data-transfer"
 	"github.com/libp2p/go-libp2p-core/peer"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
 )
 
 type channelEnvironment struct {

diff --git a/impl/events.go b/impl/events.go
@@ -4,12 +4,13 @@ import (
 	"context"
 	"errors"
 
-	datatransfer "github.com/filecoin-project/go-data-transfer"
-	"github.com/filecoin-project/go-data-transfer/encoding"
-	"github.com/filecoin-project/go-data-transfer/registry"
 	"github.com/ipfs/go-cid"
 	"github.com/ipld/go-ipld-prime"
 	"github.com/libp2p/go-libp2p-core/peer"
+
+	datatransfer "github.com/filecoin-project/go-data-transfer"
+	"github.com/filecoin-project/go-data-transfer/encoding"
+	"github.com/filecoin-project/go-data-transfer/registry"
 )
 
 func (m *manager) OnChannelOpened(chid datatransfer.ChannelID) error {

diff --git a/impl/impl.go b/impl/impl.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/hannahhoward/go-pubsub"
 	"github.com/ipfs/go-cid"
 	"github.com/ipfs/go-datastore"
 	logging "github.com/ipfs/go-log"
@@ -13,14 +14,14 @@ import (
 	"github.com/libp2p/go-libp2p-core/peer"
 	"golang.org/x/xerrors"
 
+	"github.com/filecoin-project/go-storedcounter"
+
 	datatransfer "github.com/filecoin-project/go-data-transfer"
 	"github.com/filecoin-project/go-data-transfer/channels"
 	"github.com/filecoin-project/go-data-transfer/encoding"
 	"github.com/filecoin-project/go-data-transfer/message"
 	"github.com/filecoin-project/go-data-transfer/network"
 	"github.com/filecoin-project/go-data-transfer/registry"
-	"github.com/filecoin-project/go-storedcounter"
-	"github.com/hannahhoward/go-pubsub"
 )
 
 var log = logging.Logger("dt-impl")