Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move developer documentation to its own file
- Loading branch information
Showing
3 changed files
with
63 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Development | ||
|
||
This project uses [glide](https://github.com/Masterminds/glide) to manage vendored dependencies. | ||
|
||
## Project setup | ||
|
||
1. Install Go 1.6+, and ensure your `GOPATH` is set. Using [gvm](https://github.com/moovweb/gvm) is recommended. | ||
1. Install the tool. | ||
|
||
```sh | ||
go get github.com/opencontrol/compliance-masonry | ||
compliance-masonry | ||
``` | ||
|
||
This should print out usage documentation. You can find the code in `$GOPATH/src/github.com/opencontrol/compliance-masonry/`. | ||
|
||
## Running tests | ||
|
||
```sh | ||
# Get test dependencies | ||
go get -t ./... | ||
# Run tests | ||
go test $(glide nv) | ||
``` | ||
|
||
## Updating dependencies | ||
|
||
Masonry uses [glide](https://github.com/Masterminds/glide) to manage dependencies. | ||
|
||
```sh | ||
go get github.com/Masterminds/glide | ||
glide up --all-dependencies | ||
``` | ||
|
||
## Creating binaries | ||
|
||
### One-time setup for uploading binaries | ||
|
||
1. Install [goxc](go get github.com/laher/goxc) | ||
|
||
```sh | ||
go get github.com/laher/goxc | ||
``` | ||
|
||
1. [Get a GitHub API token](https://github.com/settings/tokens/new). The token should have write access to repos. | ||
1. Add a .goxc.local.json file with a github api key | ||
|
||
```sh | ||
goxc -wlc default publish-github -apikey=123456789012 | ||
``` | ||
|
||
### Compiling and uploading binaries | ||
|
||
1. Set version number in: | ||
* [`.goxc.json`](.goxc.json) | ||
* As `app.Version` in [`masonry-go.go`](masonry-go.go) | ||
1. Run the release script | ||
|
||
```sh | ||
./release.sh | ||
``` |