From c61b3e5407b59bced3c0b38342cc8acab29dc551 Mon Sep 17 00:00:00 2001 From: Matthieu Vachon Date: Sat, 16 Oct 2021 09:52:43 -0400 Subject: [PATCH] Added release instructions --- .gitignore | 3 ++- .goreleaser.yml | 31 +++++++++++++++++++++++++++++++ README.md | 10 ++++++++++ 3 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 .goreleaser.yml diff --git a/.gitignore b/.gitignore index 06bc364a..444f1eb1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .envrc .idea .DS_Store -.vscode \ No newline at end of file +.vscode +/dist \ No newline at end of file diff --git a/.goreleaser.yml b/.goreleaser.yml new file mode 100644 index 00000000..39e971aa --- /dev/null +++ b/.goreleaser.yml @@ -0,0 +1,31 @@ +project_name: eos-go + +env_files: + github_token: ~/.config/goreleaser/github_token + +release: + github: + owner: eoscanada + name: eos-go + draft: true + name_template: '{{.Tag}}' + extra_files: + - glob: ./release/**/* + +changelog: + sort: asc + filters: + exclude: + - '^docs:' + - '^test:' + +builds: +- skip: true + +archives: +- files: + - LICENSE + - README.md + +snapshot: + name_template: "{{ .Tag }}-next" diff --git a/README.md b/README.md index 5e8a83d4..212c26bf 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,16 @@ HTTP communication and `peering.eosn.io` for P2P communication. They can respectively be overridden by specifying environment variable `EOS_GO_API_URL` and `EOS_GO_P2P_ENDPOINT` respectively. +### Release + +We are using [Goreleaser](https://goreleaser.com/) to perform releases. Install the `goreleaser` binary ([instructions](https://goreleaser.com/install/)) +and follow these steps: + +- Dry run release process first with `goreleaser release --skip-publish --skip-validate --rm-dist` +- Publish **draft** release with `goreleaser release --rm-dist` +- Open GitHub's release and check that the release messages are all good +- Once everything is good, publish release + ### Contributing Any contributions are welcome, use your standard GitHub-fu to pitch in and improve.