summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <lwirzenius@wikimedia.org>2019-05-06 16:54:02 +0300
committerLars Wirzenius <lwirzenius@wikimedia.org>2019-05-06 16:54:02 +0300
commit0ec7a5e77609f6d0644549914c18f85a12c38b46 (patch)
tree36d75712835dbd9f413ccc1830178e8d61beeab9
parentb254cffa2a3663b5ef7ff48cbeeb59460e967ff1 (diff)
downloadwmf-ci-arch-0ec7a5e77609f6d0644549914c18f85a12c38b46.tar.gz
Change: make FEEDBACK2 a sub-req of FEEDBACK
-rw-r--r--ci-arch.html8
-rw-r--r--ci-arch.mdwn11
-rw-r--r--ci-arch.pdfbin181568 -> 181334 bytes
3 files changed, 11 insertions, 8 deletions
diff --git a/ci-arch.html b/ci-arch.html
index 4b25bca..c1b6369 100644
--- a/ci-arch.html
+++ b/ci-arch.html
@@ -58,7 +58,7 @@
<li><p>Each requirement is given a semi-mnemonic unique identifier, so it can be referred to easily.</p></li>
<li><p>The goal is to make requirements be as clear and atomic as possible, so that the implementation can be more easily evaluated against the requirement: it’s better to split a big, complicated requirement into smaller ones so they can be considered separately. The original requirement can be a parent to all its parts.</p></li>
<li><p>FIXME: We may want to have a way to track which requirements are being fulfilled, or tested by automated acceptance tests. Need to add something for this, maybe a spreadsheet.</p></li>
-<li><p>These requirements were originally written up at <a href="https://www.mediawiki.org/wiki/Wikimedia_Release_Engineering_Team/CI_Futures_WG/Requirements" class="uri">https://www.mediawiki.org/wiki/Wikimedia_Release_Engineering_Team/CI_Futures_WG/Requirements</a> and have been changed a little compared to that (as of the 21 March 2019 version).</p></li>
+<li><p>These requirements were originally written up in the <a href="https://www.mediawiki.org/wiki/Wikimedia_Release_Engineering_Team/CI_Futures_WG/Requirements">WG wiki pages</a> and have been changed a little compared to that (as of the 21 March 2019 version).</p></li>
</ul>
<h2 id="very-hard-requirements">Very hard requirements</h2>
<ul>
@@ -84,8 +84,10 @@
</ul></li>
<li><p><strong>(TRANSPARENT)</strong> Must make its status and what-is-going-on visible so that its operation can be monitored and so that our developers can check the status of their builds themselves. Also the overall status of CI, for example, so they can see if their build is blocked by waiting on others.</p></li>
<li><p><strong>(FEEDBACK)</strong> Must provide feedback to the developers as early as possible for the various stages of a build, especially the early stages (“can get source from git”, “can build”, “can run unit tests”, etc.).</p>
-<p>The goal is to give feedback as soon as possible, especially in the case of the build failing.</p></li>
-<li><p><strong>(FEEDBACK2)</strong> Must support providing feedback via Gerrit, IRC, and Phabricator, at the very least. These are our current main feedback channels.</p></li>
+<p>The goal is to give feedback as soon as possible, especially in the case of the build failing.</p>
+<ul>
+<li><strong>(FEEDBACK2)</strong> Must support providing feedback via Gerrit, IRC, and Phabricator, at the very least. These are our current main feedback channels.</li>
+</ul></li>
<li><p><strong>(SECURE)</strong> Must be secure enough that we can open it to community developers to use without too much supervision.</p></li>
<li><p><strong>(MAINTAINED)</strong> Must be maintained and supported upstream. The CI system should not require substantial development from the Foundation. Some customization is expected to be necessary.</p></li>
<li><p><strong>(MANYREPOS)</strong> Must be able to handle the number of repositories, projects, builds, and deployments that we have, and will have in the foreseeable future.</p></li>
diff --git a/ci-arch.mdwn b/ci-arch.mdwn
index 86f7016..d4f308a 100644
--- a/ci-arch.mdwn
+++ b/ci-arch.mdwn
@@ -65,11 +65,12 @@ abstract: |
being fulfilled, or tested by automated acceptance tests. Need to
add something for this, maybe a spreadsheet.
-* These requirements were originally written up at
- <https://www.mediawiki.org/wiki/Wikimedia_Release_Engineering_Team/CI_Futures_WG/Requirements>
+* These requirements were originally written up in the [WG wiki pages][]
and have been changed a little compared to that (as of the 21 March
2019 version).
+[WG wiki pages]: https://www.mediawiki.org/wiki/Wikimedia_Release_Engineering_Team/CI_Futures_WG/Requirements
+
## Very hard requirements
* These are non-negotiable requirement that must all be fulfilled by a
@@ -128,9 +129,9 @@ abstract: |
The goal is to give feedback as soon as possible, especially in the
case of the build failing.
-* **(FEEDBACK2)** Must support providing feedback via Gerrit, IRC, and
- Phabricator, at the very least. These are our current main feedback
- channels.
+ * **(FEEDBACK2)** Must support providing feedback via Gerrit, IRC, and
+ Phabricator, at the very least. These are our current main feedback
+ channels.
* **(SECURE)** Must be secure enough that we can open it to community
developers to use without too much supervision.
diff --git a/ci-arch.pdf b/ci-arch.pdf
index 6765174..7fb6a9e 100644
--- a/ci-arch.pdf
+++ b/ci-arch.pdf
Binary files differ