From 7d7c889285b8b2213a490eaff99f926113e68ad9 Mon Sep 17 00:00:00 2001 From: Jeff Regan Date: Fri, 24 Jul 2020 16:04:29 -0700 Subject: [PATCH] Update README.md --- releasing/README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/releasing/README.md b/releasing/README.md index a99167207..beaa872e8 100644 --- a/releasing/README.md +++ b/releasing/README.md @@ -11,7 +11,16 @@ [`cloudbuild.yaml`]: cloudbuild.yaml This document describes how to perform a [semver release] -of one of the [Go modules] in this repository. +of one of the several [Go modules] in this repository. + +> This process doesn't describe or enforce a +> particular module release sequence. There's a non-cyclic +> dependence among the some of the modules defined in their +> respective `go.mod` files. If module `foo` depends on +> module `bar`, and clients of `foo` would see an immediate +> benefit from a change in `bar`, then a release of `bar` +> should be followed by a change to `foo`'s `go.mod` +> file and a subsequent release of `foo`. Briefly: - The repo HEAD is in a clean state (all tests passing). @@ -21,6 +30,7 @@ Briefly: [`cloudbuild.yaml`] in this directory, creates release artifacts as needed and makes them available on the [release page]. + ## Public Modules TODO: _This list is incomplete._