Updating documentation
diff --git a/CHANGELOG.md b/CHANGELOG.md index a7fce32..799f311 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md
@@ -1,3 +1,20 @@ +# Release 0.10.0 (2016-03-XX) + +- Issue #293: Added support for importing from Gomfile's (thanks mcuelenaere). +- Issue #318: Opt-In to strip VCS metadata from vendor directory. +- Issue #297: Adds exclude property for directories in local codebase to exclude + from scanning. +- Issue #301: Detect version control type from scp style paths (e.g. git@) and + from scheme types (e.g., git://). +- Issue #339: Add ability to remove nested vendor and Godeps workspaces + directories. Note, if Godeps rewriting occured it is undone. The Godeps handling + is deprecated from day one and will be removed when most Godeps projects have + migrated to vendor folder handling. +- Issue #350: More detailed conflict information (commit metadata displayed). +- Issue #351: Move to Gitter for chat. +- Issue #352: Make Glide installable. The dependencies are checked into the + `vendor` folder. + # Release 0.9.3 (2016-03-09) - Fixed #324: Glide tries to update ignored package
diff --git a/README.md b/README.md index 532ed3e..5f7723b 100644 --- a/README.md +++ b/README.md
@@ -12,7 +12,7 @@ installed by a tool (e.g. glide), similar to `go get` or they can be vendored and distributed with the package. -[](https://travis-ci.org/Masterminds/glide) [](http://goreportcard.com/report/Masterminds/glide) [](https://godoc.org/github.com/Masterminds/glide) [](http://glide.readthedocs.org/en/latest/?badge=latest) [](https://gitter.im/Masterminds/glide?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[](https://travis-ci.org/Masterminds/glide) [](http://goreportcard.com/report/Masterminds/glide) [](https://godoc.org/github.com/Masterminds/glide) [](http://glide.readthedocs.org/en/stable/?badge=stable) [](http://glide.readthedocs.org/en/latest/?badge=latest) [](https://gitter.im/Masterminds/glide?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ### Features @@ -32,6 +32,8 @@ * Repository caching including reuse of packages in the `$GOPATH` * Flatten dependencies resolving version differences and avoiding the inclusion of a package multiple times. +* Manage and install dependencies on-demand or vendored in your version control + system. ## How It Works
diff --git a/docs/commands.md b/docs/commands.md index 667bdac..3699e6f 100644 --- a/docs/commands.md +++ b/docs/commands.md
@@ -49,6 +49,18 @@ A `glide.lock` file will be created or updated with the dependencies pinned to specific versions. For example, if in the `glide.yaml` file a version was specified as a range (e.g., `^1.2.3`) it will be set to a specific commit id in the `glide.lock` file. That allows for reproducible installs (see `glide install`). +If you want to use `glide up` to help you managed dependencies that are checked into your version control consider the flags: + +* `--update-vendored` (aliased to `-u`) to update the vendored dependencies. +* `--strip-vcs` (aliased to `-s`) to strip VCS metadata (e.g., `.git` directories) from the `vendor` folder. +* `--strip-vendor` (aliased to `-v`) to strip nested `vendor/` directories. + +For example, you can use the command: + + $ glide up -u -s + +This will tell Glide to update the vendored packages and remove any VCS directories from transitive dependencies that were picked up as well. + ## glide install When you want to install the specific versions from the `glide.lock` file use `glide install`.
diff --git a/docs/faq.md b/docs/faq.md index 15dcbf9..fcc9837 100644 --- a/docs/faq.md +++ b/docs/faq.md
@@ -10,7 +10,13 @@ ## Q: Should I check `vendor/` into version control? -That's up to you. It's not necessary, but it may also cause you extra work and lots of extra space in your VCS. There may also be unforeseen errors ([see an example](https://github.com/mattfarina/golang-broken-vendor)). +That's up to you. It's a personal or organizational decision. Glide will help you install the outside dependencies on demand or help you manage the dependencies as they are checked into your version control system. + +By default, commands such as `glide update` and `glide install` install on-demand. To manage a vendor folder that's checked into version control use the flags: + +* `--update-vendored` (aliased to `-u`) to update the vendored dependencies. +* `--strip-vcs` (aliased to `-s`) to strip VCS metadata (e.g., `.git` directories) from the `vendor` folder. +* `--strip-vendor` (aliased to `-v`) to strip nested `vendor/` directories. ## Q: How do I import settings from GPM, Godep, or gb?