diff --git a/README.md b/README.md index 01cf0d6..ed9155f 100644 --- a/README.md +++ b/README.md @@ -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 + ```