mirror of
https://github.com/securego/gosec.git
synced 2024-12-28 05:25:53 +00:00
Update README with more details about the release process
This commit is contained in:
parent
0abfbefa02
commit
c119875ea0
1 changed files with 13 additions and 9 deletions
22
README.md
22
README.md
|
@ -143,34 +143,38 @@ make test
|
||||||
|
|
||||||
#### Release Build
|
#### 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
|
```bash
|
||||||
make release VERSION=2.0.0
|
git tag 1.0.0
|
||||||
|
export GITHUB_TOKEN=<YOUR 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 - Go AST Scanner
|
||||||
|
|
||||||
Gas analyzes Go source code to look for common programming mistakes that
|
Gas analyzes Go source code to look for common programming mistakes that
|
||||||
can lead to security problems.
|
can lead to security problems.
|
||||||
|
|
||||||
VERSION: 2.0.0
|
VERSION: 1.0.0
|
||||||
GIT TAG: 96489ff
|
GIT TAG: 1.0.0
|
||||||
BUILD DATE: 2018-02-21
|
BUILD DATE: 2018-04-27T12:41:38Z
|
||||||
|
|
||||||
```
|
```
|
||||||
|
Note that all released archives are also uploaded to GitHub.
|
||||||
|
|
||||||
#### Docker image
|
#### Docker image
|
||||||
|
|
||||||
You can execute a release and build the docker image as follows:
|
You can execute a release and build the docker image as follows:
|
||||||
|
|
||||||
```
|
```
|
||||||
make image VERSION=2.0.0
|
git tag <VERSION>
|
||||||
|
export GITHUB_TOKEN=<Your GitHub token>
|
||||||
|
make image
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you can run the gas tool in a container against your local workspace:
|
Now you can run the gas tool in a container against your local workspace:
|
||||||
|
|
Loading…
Reference in a new issue