Browse Source

add dependencies workflow to DEVELOPING.md

tags/v2.8.0-rc1
Shivaram Lingamneni 2 years ago
parent
commit
e71643eb73
1 changed files with 10 additions and 0 deletions
  1. 10
    0
      DEVELOPING.md

+ 10
- 0
DEVELOPING.md View File

@@ -25,6 +25,16 @@ For either particularly broken or particularly WiP changes, we work on them in a
25 25
 Develop branches are either used to work out implementation details in preperation for a cleaned-up version, for half-written ideas we want to continue persuing, or for stuff that we just don't want on `master` yet for whatever reason.
26 26
 
27 27
 
28
+## Updating dependencies
29
+
30
+Ergo vendors all dependencies using `go mod vendor`. To update a dependency, or add a new one:
31
+
32
+1. `go get -v bazbat.com/path/to/dependency` ; this downloads the new dependency
33
+2. `go mod vendor` ; this writes the dependency's source files to the `vendor/` directory
34
+3. `git add go.mod go.sum vendor/` ; this stages all relevant changes to the vendor directory, including file deletions. Take care that spurious changes (such as editor swapfiles) aren't added.
35
+4. `git commit`
36
+
37
+
28 38
 ## Releasing a new version
29 39
 
30 40
 1. Ensure the tests pass, locally on travis (`make test`, `make smoke`, and `make irctest`)

Loading…
Cancel
Save