1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

Documentation: Add vendoring details. (#596)

* Add vendoring details.

* Address @geek1011's comments.

* fixup!
This commit is contained in:
Tom Limoncelli
2020-01-28 10:44:07 -05:00
committed by GitHub
parent 2f83aa9302
commit ae3a730e64

View File

@@ -7,6 +7,44 @@ title: How to build and ship a release
Here are my notes from producing the v0.2.8 release. Change the version number as appropriate. Here are my notes from producing the v0.2.8 release. Change the version number as appropriate.
## Tip: How to keep modules updated
List out-of-date modules and update any that
```
go get -u github.com/psampaz/go-mod-outdated
go list -u -m -json all | go-mod-outdated -update -direct
```
To update a module, `get` it, then re-run the unit and integration tests.
```
go get -u
or
go get -u module/path
```
Once the updates are complete, tidy up:
```
go mod tidy
```
When done, vendor the modules (see Step 0 below).
## Step 0. Vendor the modules
Vendor the modules. The vendored files are not used (unless you change
the builds to use `-mod=vendor`). They are maintained simply to make
sure that we have a backup in the unlikely event of a disaster.
```
go mod vendor
```
TODO(Tom): build.go should verify that this was done, similar to
how it tests that gofmt was run.
## Step 1. Run the integration tests ## Step 1. Run the integration tests
* If you are at StackOverflow, this is in TC as "DNS > Integration Tests". * If you are at StackOverflow, this is in TC as "DNS > Integration Tests".