-
Notifications
You must be signed in to change notification settings - Fork 74
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.
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
Migrate project to (only) Go modules #12
Closed
nrcook
wants to merge
2
commits into
sonatype-nexus-community:master
from
nrcook:all-mod-all-the-time
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
|
@@ -21,7 +21,7 @@ You can see an example of using `nancy` in Travis-CI at [this intentionally vuln | |
### DISCLAIMER | ||
|
||
A portion of the golang ecosystem doesn't use proper versions, and instead uses a commit hash to resolve your dependency. Dependencies like this will not work with | ||
`nancy` quite yet, as we don't have a mechanism on OSS Index to lookup vulnerabilities in that manner. | ||
`nancy` quite yet, as we don't have a mechanism on OSS Index to lookup vulnerabilities in that manner. | ||
|
||
## Why Nancy? | ||
|
||
|
@@ -38,19 +38,16 @@ At current time you have a few options: | |
|
||
### Build from source | ||
|
||
* Run `go get -u github.com/sonatype-nexus-community/nancy` | ||
* Nancy should now be available wherever your GOPATH is set | ||
* Run `dep ensure` in the root of the project | ||
* In the root of the project `go test ./...` | ||
* If tests checkout go ahead and run `go build`. | ||
* Use that binary where ever your heart so desires! | ||
|
||
For the adventurous, we have `go.mod` files that enable you to build using [go modules](https://github.com/golang/go/wiki/Modules). | ||
`nancy` is built with Go 1.11 and supports Go modules. The easiest way to get started is to clone Nancy into a directory outside of the `$GOPATH`. | ||
For example: | ||
|
||
``` | ||
$ export GO111MODULE=on | ||
$ go test ./... | ||
$ go build | ||
mkdir $HOME/code | ||
cd $HOME/code | ||
git clone https://github.com/sonatype-nexus-community/nancy.git | ||
cd nancy | ||
go install | ||
|
||
``` | ||
|
||
### Download release binary | ||
|
@@ -61,11 +58,18 @@ Each commit to master creates a new release binary, and if you'd like to skip bu | |
|
||
## Development | ||
|
||
`nancy` is written using Golang 1.11, so it is best you start there. | ||
`nancy` is built with Go 1.11 and supports Go modules. The easiest way to get started is to clone Nancy into a directory outside of the `$GOPATH`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This and |
||
For example: | ||
|
||
This project also uses `dep` for dependencies, so you will need to download `dep`. | ||
``` | ||
mkdir $HOME/code | ||
cd $HOME/code | ||
git clone https://github.com/sonatype-nexus-community/nancy.git | ||
cd nancy | ||
go test ./... -v | ||
go build | ||
|
||
Tests can be run like `go test ./... -v` | ||
``` | ||
|
||
## Contributing | ||
|
||
|
@@ -75,7 +79,7 @@ a new issue, or comment on an existing issue, to let others know you are! | |
|
||
## Acknowledgements | ||
|
||
The `nancy` logo was created using a combo of [Gopherize.me](https://gopherize.me/) and good ole Photoshop. Thanks to the creators of | ||
The `nancy` logo was created using a combo of [Gopherize.me](https://gopherize.me/) and good ole Photoshop. Thanks to the creators of | ||
Gopherize for an easy way to make a fun Gopher :) | ||
|
||
Original Gopher designed by Renee French. | ||
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should still stick around as we still support dep from a nancy standpoint and this is effectively an "integration test". Maybe just move that file into a directory and point this to it.