From c119875ea0d5341b96ae43ea8310794125cfdc33 Mon Sep 17 00:00:00 2001 From: Cosmin Cojocar Date: Fri, 27 Apr 2018 14:59:19 +0200 Subject: [PATCH] Update README with more details about the release process --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5646d9b..abadf2d 100644 --- a/README.md +++ b/README.md @@ -143,34 +143,38 @@ make test #### Release Build -Gas can be released as follows: +Make sure you have installed the [goreleaser](https://github.com/goreleaser/goreleaser) tool and then you can release Gas as follows: ```bash -make release VERSION=2.0.0 +git tag 1.0.0 +export GITHUB_TOKEN= +make release ``` -The released version of the tool is available in the `build` folder. The build information should be displayed in the usage text. +The released version of the tool is available in the `dist` folder. The build information should be displayed in the usage text. ``` -./build/gas-2.0.0-linux-amd64 -h +./dist/darwin_amd64/gas -h GAS - Go AST Scanner Gas analyzes Go source code to look for common programming mistakes that can lead to security problems. -VERSION: 2.0.0 -GIT TAG: 96489ff -BUILD DATE: 2018-02-21 - +VERSION: 1.0.0 +GIT TAG: 1.0.0 +BUILD DATE: 2018-04-27T12:41:38Z ``` +Note that all released archives are also uploaded to GitHub. #### Docker image You can execute a release and build the docker image as follows: ``` -make image VERSION=2.0.0 +git tag +export GITHUB_TOKEN= +make image ``` Now you can run the gas tool in a container against your local workspace: