From b287ad08b526cb71005bc3340b032d7f4e4f8b4e Mon Sep 17 00:00:00 2001
From: Lars Wirzenius <lwirzenius@wikimedia.org>
Date: Mon, 20 May 2019 19:33:52 +0300
Subject: Add: document revision chapter

---
 ci-arch.html |  20 ++++++++++++++++++++
 ci-arch.mdwn |  18 ++++++++++++++++++
 ci-arch.pdf  | Bin 286839 -> 289095 bytes
 3 files changed, 38 insertions(+)

diff --git a/ci-arch.html b/ci-arch.html
index 7a448dc..aa22eac 100644
--- a/ci-arch.html
+++ b/ci-arch.html
@@ -21,6 +21,7 @@
 </header>
 <nav id="TOC">
 <ul>
+<li><a href="#revisions-of-this-document">Revisions of this document</a></li>
 <li><a href="#introduction">Introduction</a><ul>
 <li><a href="#vision-for-ci">Vision for CI</a></li>
 <li><a href="#overall-solution-approach">Overall solution approach</a></li>
@@ -53,6 +54,25 @@
 <li><a href="#transitioning-to-new-ci-system">Transitioning to new CI system</a></li>
 </ul>
 </nav>
+<h1 id="revisions-of-this-document">Revisions of this document</h1>
+<ul>
+<li>draft-1
+<ul>
+<li>first revision shared within RelEng</li>
+</ul></li>
+<li>draft-2
+<ul>
+<li>add: revision chapter to summarise changes since previous document “release”</li>
+<li>add: placeholder chapter for transition from old CI</li>
+<li>add requirements: DEPLOYCIBUILT, CLEANBUILDENV</li>
+<li>elevate to hard requirements: HA, CLEANWORKSPACE, SECRETS</li>
+<li>add: note that work-in-progress changes can be reviewed before CI builds and tests them</li>
+<li>change: UNDERSTANDABLE clarified, with acceptance criterion</li>
+<li>change: CLEANWORKSPACE clarfiied</li>
+<li>change: pipeline simplified</li>
+<li>document version is now set automatically with <code>git describe</code></li>
+</ul></li>
+</ul>
 <h1 id="introduction">Introduction</h1>
 <p>CI WG plans replacement of its current WMF CI system with one of Argo, GitLab CI, Zuul v3. These were selected in the first phase of the CI WG.</p>
 <p>We aim to do “continuous deployment”, not only “continous integration” or “continuous delivery”. The goal is to deploy changes to production as often and as quickly as possible, without compromising on the safety and security of the production environment.</p>
diff --git a/ci-arch.mdwn b/ci-arch.mdwn
index 9f656a6..9b38764 100644
--- a/ci-arch.mdwn
+++ b/ci-arch.mdwn
@@ -27,6 +27,24 @@ abstract: |
 ...
 
 
+# Revisions of this document
+
+* draft-1
+    * first revision shared within RelEng
+
+* draft-2
+    * add: revision chapter to summarise changes since previous
+      document "release"
+    * add: placeholder chapter for transition from old CI
+    * add requirements: DEPLOYCIBUILT, CLEANBUILDENV
+    * elevate to hard requirements: HA, CLEANWORKSPACE, SECRETS
+    * add: note that work-in-progress changes can be reviewed before
+      CI builds and tests them
+    * change: UNDERSTANDABLE clarified, with acceptance criterion
+    * change: CLEANWORKSPACE clarfiied
+    * change: pipeline simplified
+    * document version is now set automatically with `git describe`
+
 # Introduction
 
 CI WG plans replacement of its current WMF CI system with one of Argo,
diff --git a/ci-arch.pdf b/ci-arch.pdf
index 076f58d..9673592 100644
Binary files a/ci-arch.pdf and b/ci-arch.pdf differ
-- 
cgit v1.2.1