Hashar has submitted this change and it was merged.

Change subject: doc additions
......................................................................


doc additions

Change-Id: I461beffb09b05cd4dab6368b77999284e1c8ee86
---
M README
M beta.yaml
M integration.yaml
3 files changed, 47 insertions(+), 5 deletions(-)

Approvals:
  Hashar: Verified; Looks good to me, approved
  jenkins-bot: Verified



diff --git a/README b/README
index 8844f67..db506fb 100644
--- a/README
+++ b/README
@@ -1,3 +1,15 @@
-See online documentation at:
+Wikimedia configuration for Jenkins
+===================================
 
-http://ci.openstack.org/jenkins-job-builder/
+This repository hold the configuration of the Wikimedia Foundation Inc. Jenkins
+jobs.  It is meant to be used with a python script written by the OpenStack
+Foundation: Jenkins Job Builder.
+
+If you ever need to tweak or add jobs, you will want to have a look at our
+online documentation maintained on a wiki:
+
+  https://www.mediawiki.org/wiki/CI/JJB
+
+You probably also want to have a look at the upstream documentation:
+
+  http://ci.openstack.org/jenkins-job-builder/
diff --git a/beta.yaml b/beta.yaml
index 23cf31d..cca39a2 100644
--- a/beta.yaml
+++ b/beta.yaml
@@ -14,7 +14,7 @@
 #  - job:
 #    name: beta-myawesomeness
 #    defaults: beta
-#
+#    <your stuff there>
 
 # Basic valid defaults, making sure we run on the deployment-bastion host
 # slave nodes which is in labs.
@@ -60,6 +60,15 @@
          sudo -u mwdeploy /usr/bin/scap-recompile
 
 
+# Job to run MediaWiki update.php script on all the beta wikis.
+#
+# It is a matrix job which is a very nice feature in Jenkins to have a job run
+# with different input parameters.  It is current drawback is that the list of
+# databases is hardcoded in the Jenkins job (ie below) when it should really be
+# generated out of the current list of database (which is all-labs.dblist in
+# the repository operations/mediawiki-config.git). FIXME We should workaround
+# this by having an integration test that would make sure boths repositories
+# are in sync.
 - job:
     name: beta-update-databases
     defaults: beta
@@ -99,16 +108,27 @@
          - testwiki
          - wikidatawiki
 
+    # The 'wikidb' axis defined above is exported by Jenkins as an
+    # environnement variable. Makes it trivial to run on all databases.
     builders:
      - shell: "sudo -u mwdeploy mwscript update.php --wiki=$wikidb --quick"
 
+    # We do not have a good way to detect databases modifications, so just spam
+    # the beta cluster with update requests.
     triggers:
      - timed: '@hourly'
 
-# On merge of mediawiki-config.git, checkout on beta
+# Job to deploy the Wikimedia MediaWiki configuration files
+#
+# The configuration files are hosted in operations/mediawiki-config.git which
+# is deployed manually on the production cluster.  On beta, we cant really keep
+# up with all the changes, so we deploy them on sight.
+#
+# We simply update the repository on the beta host and do a git reset hard.
+#
 - job:
     name: beta-mediawiki-config-update
-    defaults: use-zuul
+    defaults: use-zuul  # FIXME should use 'beta' probably
 
     triggers:
      - zuul
diff --git a/integration.yaml b/integration.yaml
index b2490e6..8b8c8d2 100644
--- a/integration.yaml
+++ b/integration.yaml
@@ -1,3 +1,10 @@
+# Jobs for integration/*
+
+# Job that update the file hierarchy maintained by CI.
+#
+# As of July 2013 the two main entry points are:
+# - integration.wikimedia.org
+# - doc.wikimedia.org
 - job-template:
     name: 'integration-docroot-deploy'
     node: gallium
@@ -25,6 +32,9 @@
         # FIXME change path whenever we have zuul packaged.
         /usr/local/bin/zuul-server -c /etc/zuul/public.conf -t -l 
"$WORKSPACE"/layout.yaml
 
+# Job for Zuul configuration validation
+# Make sure the Zuul config is passed and show a different with the previous
+# config.
 - job-template:
     name: 'integration-zuul-layoutdiff'
     node: gallium  # it is running Zuul

-- 
To view, visit https://gerrit.wikimedia.org/r/72315
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I461beffb09b05cd4dab6368b77999284e1c8ee86
Gerrit-PatchSet: 1
Gerrit-Project: integration/jenkins-job-builder-config
Gerrit-Branch: master
Gerrit-Owner: Hashar <has...@free.fr>
Gerrit-Reviewer: Hashar <has...@free.fr>
Gerrit-Reviewer: jenkins-bot

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to