Explain first-run vs. day-to-day workflow

- Explain that `dep init` will try and import from other package
  managers
- Explain the day-to-day workflow of using Dep.
This commit is contained in:
Aidan Feldman 2017-07-18 22:34:19 -04:00
Родитель 298cffbe1c
Коммит 8f94e292b5
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 768610EA814A731B
1 изменённых файлов: 25 добавлений и 2 удалений

Просмотреть файл

@ -31,20 +31,42 @@ That said, keep in mind the following:
## Usage ## Usage
### Initial setup
Get the tool via Get the tool via
```sh ```sh
$ go get -u github.com/golang/dep/cmd/dep $ go get -u github.com/golang/dep/cmd/dep
``` ```
Typical usage - either on a new project or converting an existing one - is To set up Dep on a project, run the following from your project root directory:
```sh ```sh
$ dep init $ dep init
$ dep ensure -update $ dep ensure -update
``` ```
If your project was already using a `vendor/` directory, it was backed up to `_vendor-TIMESTAMP/`. `dep init` will do the following:
1. Look for [existing dependency management
files](docs/FAQ.md#what-external-tools-are-supported) to convert
1. Back up your existing `vendor/` directory to
`_vendor-TIMESTAMP/`
1. Generate [`Gopkg.toml`](Gopkg.toml.md) and `Gopkg.lock` files
### Day-to-day workflow
When you or a collaborator add/remove/change dependencies, run
```sh
$ dep ensure
```
This will synchronize your dependencies in `vendor/` to make sure they match
what's in your `import`s and `Gopkg.toml`. `dep ensure` is safe to run early and
often.
#### Updating a specific dependency
To update a dependency to a new version, you might run To update a dependency to a new version, you might run
@ -56,6 +78,7 @@ See the help text for more detailed usage instructions.
```sh ```sh
$ dep help ensure $ dep help ensure
$ dep ensure -examples
``` ```
## Feedback ## Feedback