Skip to content

Commit

Permalink
Vendor & script updates (#88)
Browse files Browse the repository at this point in the history
* Changed Godep to use vendor directory instead of obsolete _workspace folder.
Added batch files for windows to run tests.

Signed-off-by: Richard Case <[email protected]>

* Updated README with an example of opening multiple ports on a IP address.

Signed-off-by: Richard Case <[email protected]>
  • Loading branch information
richardcase authored Nov 22, 2016
1 parent 4a3a2f9 commit 489cade
Show file tree
Hide file tree
Showing 144 changed files with 427 additions and 25,146 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ instructions below may not work properly on Windows.

* [Install Go](https://golang.org/).
* Install Godep: `go get github.com/tools/godep`.
* Clone this repo (do **not** use `go get`).
* [Ensure your $GOPATH is set correctly](http://golang.org/cmd/go/#hdr-GOPATH_environment_variable). Working in a clean environment without any other packages on $GOPATH is highly encouraged to avoid conflicts with the dependencies of the tool. Using a [gvm tool](https://github.com/moovweb/gvm) is a good choice for setting up a clean environment. Also, gvm is a convenient tool for installing cross-compilation prerequisites.
* Install dependencies with Godep: enter the repo's root and `godep restore`.
* Install go vet: `go get code.google.com/p/go.tools/cmd/vet`.
* Fork the clc-go-cli repo
* Setup your forked repo according to this [guide](https://splice.com/blog/contributing-open-source-git-repositories-go/)
* [Ensure your $GOPATH is set correctly](http://golang.org/cmd/go/#hdr-GOPATH_environment_variable). Working in a clean environment without any other packages on $GOPATH is highly encouraged to avoid conflicts with the dependencies of the tool. Using a [gvm tool](https://github.com/moovweb/gvm) is a good choice for setting up a clean environment. Also, gvm is a convenient tool for installing cross-compilation prerequisites.

### Developing

* Create a new branch for your change

* The TDD approach is recommended - write a failing test first, then fix it.

* Use a `dev` script to run commands as you change the code:
Expand All @@ -26,6 +28,8 @@ instructions below may not work properly on Windows.
* Before making a pull request check that `gofmt -d=true ./..` and `go vet ./...` do not produce any output (except for that coming from `Godeps/_workspace` - ignore it).
* Push your branch to your fork and then make a pull request from your branch to master on https://github.com/CenturyLinkCloud/clc-go-cli
* Do not commit until the unit tests have passed (`./run_tests`).
* If you want to make an executable, simply run `./scripts/build`. The binary will appear in the `./out` folder.
Expand All @@ -34,8 +38,6 @@ instructions below may not work properly on Windows.
* The API file can be regenerated by running `./scripts/generate_api`.
* Pull requests should be made against the development branch.
### Building the releases
Generally, any Linux/Darwin machine should work for building the releases. A Darwin machine is required though if you want to build a `MacOS .pkg`.
Expand Down
16 changes: 10 additions & 6 deletions Godeps/Godeps.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions Godeps/_workspace/.gitignore

This file was deleted.

24 changes: 0 additions & 24 deletions Godeps/_workspace/src/github.com/asaskevich/govalidator/error.go

This file was deleted.

This file was deleted.

19 changes: 0 additions & 19 deletions Godeps/_workspace/src/github.com/ldmberman/tablewriter/LICENCE.md

This file was deleted.

141 changes: 0 additions & 141 deletions Godeps/_workspace/src/github.com/ldmberman/tablewriter/README.md

This file was deleted.

52 changes: 0 additions & 52 deletions Godeps/_workspace/src/github.com/ldmberman/tablewriter/csv.go

This file was deleted.

This file was deleted.

Loading

0 comments on commit 489cade

Please sign in to comment.