Skip to content

Commit

Permalink
Add release instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
slai committed Jan 3, 2019
1 parent 35a1427 commit 1c82460
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,28 @@ Installation
Notes:
------
It requires a config file, see `config.yml`. Drop the `credentialsfile` parameter to use the [default AWS credentials chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials).

Release
-------

go-minipypi uses [goreleaser](https://github.com/goreleaser/goreleaser) locally for releases.

1. Install [goreleaser](https://goreleaser.com/install/)

2. Ensure you're on a clean master, and tag the current commit for release -

```sh
git tag -a "v0.4.0"
```

3. Do a dry-run of the release if necessary and check the artifacts in `dist/` -

```sh
goreleaser --skip-publish
```

4. Using your GitHub token, complete the release -

```sh
GITHUB_TOKEN=your_github_token_with_release_privileges goreleaser
```

0 comments on commit 1c82460

Please sign in to comment.