diff --git a/.goreleaser.yml b/.goreleaser.yml index 9a37efab..fb5ebc3c 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -33,19 +33,6 @@ brew: email: mikeswcho@gmail.com homepage: https://dnote.io description: Capture your learning without leaving the command line - dependencies: - - go - - dep - install: | - ENV["GOPATH"] = buildpath - - (buildpath/"src/github.com/dnote/cli").install buildpath.children - cd "src/github.com/dnote/cli" do - system "dep", "ensure" - system "go", "build", "-ldflags", "-X main.apiEndpoint=https://api.dnote.io", "-o", bin/"dnote" - end - test: | - system "${bin}/dnote --version" changelog: sort: asc diff --git a/CONBTRIBUTING.md b/CONBTRIBUTING.md new file mode 100644 index 00000000..771e8081 --- /dev/null +++ b/CONBTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +This is a guide for contributors. + +## Set up + +First, download the project + +```sh +go get github.com/dnote/cli +``` + +Go to the project root and download dependencies using [dep](https://github.com/golang/dep). + +```sh +dep ensure +``` + +## Test + +Run + +```sh +./scripts/test.sh +``` + +## Release + +This project uses [goreleaser](https://github.com/goreleaser/goreleaser) to automate the release process. + +The following will tag, push the tag, create release on GitHub, build artifacts, upload them, and +push a commit to [Dnote Homebrew tap](https://github.com/dnote/homebrew-dnote). + +```sh +VERSION=v0.4.2 make +``` + +**Note** + +- If a release is not stable, + - disable the homebrew release by commenting out `homebrew` block in `.goreleaser.yml` + - mark release as pre-release on GitHub release