Skip to content

Commit

Permalink
Added release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthieu Vachon committed Oct 16, 2021
1 parent 772b30b commit c61b3e5
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.envrc
.idea
.DS_Store
.vscode
.vscode
/dist
31 changes: 31 additions & 0 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -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"
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c61b3e5

Please sign in to comment.