Mangle upstream and Debian versions for CI builds

1 files changed, 10 insertions, 5 deletions

diff --git a/doc/060-cleanly.yarn b/doc/060-cleanly.yarn
index 72ee1a4..602fc3d 100644
--- a/doc/060-cleanly.yarn
+++ b/doc/060-cleanly.yarn
@@ -15,16 +15,21 @@ what the name of the project is and what its version is.
     SCENARIO cleanly performs pipeline steps
     GIVEN a source code repository for project foo version 3.2-1
 
-    WHEN user runs, in foo, cleanly get-name
+    WHEN user runs, in foo, cleanly --ci get-name
     THEN the output is "foo\n"
 
-    WHEN user runs, in foo, cleanly get-upstream-version
-    THEN the output is "3.2\n"
+In CI mode, we want the upstream version number to be mangled, by
+appending the current build number. This avoids having to rely on the
+developers to update the version number diligently. For cleanly to do
+this, we need to tell it the build number.
+
+    WHEN user runs, in foo, cleanly --ci --buildno=5 get-upstream-version
+    THEN the output is "3.2.ci5\n"
+
 
 ## Create upstream release tar archive
 
-We create a tar archive by extracing the source code from git. The
-operation needs to know the upstream name and version number.
+We create a tar archive by extracing the source code from git.
 
     WHEN user runs, in foo, cleanly --ci --buildno 42 tarball
     THEN file foo-3.2.ci42.tar.xz exists