Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build improvments #179

Merged
merged 19 commits into from
Mar 12, 2018
Merged

Build improvments #179

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
c03f2b0
Add a semantic version to the usage text
ccojocar Feb 15, 2018
c63b61c
Add a comment to the version function
ccojocar Feb 15, 2018
21e1e84
Inject the version, git tag and build date as build variables
Feb 21, 2018
641d350
Update README
Feb 21, 2018
b5ceaf2
Fix lint warnings
Feb 21, 2018
230eac1
Update README
Feb 21, 2018
7954917
Manage dependencies with dep tool instead of godep
Feb 21, 2018
5d6eafa
Add a Makefile for common build tasks
Feb 21, 2018
2ed7dc6
Update the build file to use the make tool
Feb 21, 2018
4d53490
Update Dockerfile
Feb 21, 2018
2771efb
Add docker entry point in to make the passing of arguments easy
Feb 21, 2018
0d274ec
Update README
Feb 21, 2018
8472273
Add missing tools to the build
ccojocar Feb 22, 2018
33bcf45
Drop 1.7 support and add 1.10
ccojocar Feb 22, 2018
d18879f
Fix Go 1.10 according with the travis guidelines
ccojocar Feb 22, 2018
190aa10
Update the tls-observatory package
ccojocar Mar 11, 2018
c8a6748
Fix lint warnings
ccojocar Mar 11, 2018
b157060
Change the output of the tests to be more verbose
ccojocar Mar 11, 2018
85d72df
Check if the are build errors before executing the rule test
ccojocar Mar 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update README
  • Loading branch information
@ccojocar
Cosmin Cojocar authored and ccojocar committed Mar 11, 2018
commit 0d274ec69d315aaefbf58e199e8c05d0900fb9a8
39 changes: 30 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,24 +116,31 @@ $ gas -fmt=json -out=results.json *.go
```
### Development

#### Build


```
make
```

#### Tests

```
make tests
```

#### Release Build

Gas can be released as follows:

```bash
# Prepare the build variables
export VERSION=2.0.0
export GIT_TAG=$(git describe --always --tags)
export BUILD_DATE=$(date +%Y-%m-%d)

# Perform a release build
go build -ldflags "-X main.Version=${VERSION} -X main.GitTag=${GIT_TAG} -X main.BuildDate=${BUILD_DATE}" ./cmd/gas/
make release VERSION=2.0.0
```

The build information is now displayed in the usage text.
The released version of the tool is available in the `build` folder. The build information should be displayed in the usage text.

```
gas -h
./build/gas-2.0.0-linux-amd64 -h

GAS - Go AST Scanner

Expand All @@ -146,6 +153,20 @@ BUILD DATE: 2018-02-21

```

#### Docker image

You can execute a release and build the docker image as follows:

```
make image VERSION=2.0.0
```

Now you can run the gas tool in a container against your local workspace:

```
docker run -it -v <YOUR LOCAL WORKSPACE>:/workspace gas /workspace
```

#### Generate TLS rule

The configuration of TLS rule can be generated from [Mozilla's TLS ciphers recommendation](https://statics.tls.security.mozilla.org/server-side-tls-conf.json).
Expand Down