Skip to content

Commit c7d7335

Browse files
committed
Add guidance on SHA vs tags in dependencies
Signed-off-by: Davanum Srinivas <[email protected]>
1 parent 8439767 commit c7d7335

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

contributors/devel/sig-architecture/vendor.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,16 @@ The `go.mod` file in the root of `k8s.io/kubernetes` describes dependencies usin
3434
* `require` directives list the preferred version of dependencies (this is auto-updated by go tooling to the maximum preferred version of the module)
3535
* `replace` directives pin to specific tags or commits
3636

37+
## Dependency versions
38+
39+
As a project we prefer that all entries in `go.mod` should be tags in their
40+
respective repositories. There may be exceptions that will be up to the
41+
dependency approvers to approve. If there are issues with go mod tooling itself
42+
then there has to be explicit comment (trailing `// comment`) with details on
43+
exact tag/release that this SHA corresponds to. Also please ensure tracking
44+
isssues are open to ensure these SHA(s) are cleaned up over time and switched
45+
over to tags.
46+
3747
## Adding or updating a dependency
3848

3949
The most common things people need to do with deps are add and update them.

0 commit comments

Comments
 (0)