[Libreoffice-commits] dev-tools.git: 2 commits - bibisect/README.txt ciabot/INSTALL ciabot/README

Robinson Tryon qubit at runcibility.com
Sun Dec 7 17:43:11 PST 2014


 bibisect/README.txt |   72 ++++++++++++++++++++++++++++++++++
 ciabot/INSTALL      |   20 ++++++++-
 ciabot/README       |  110 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 200 insertions(+), 2 deletions(-)

New commits:
commit 92cc22a524fee3ded5c2bdb1b29581dcad8e07a7
Author: Robinson Tryon <qubit at runcibility.com>
Date:   Sun Dec 7 20:40:49 2014 -0500

    bibisect: Add documentation for building a bibisect repository
    
    Change-Id: Ic5954db36fdf6911ca5d451a87543f992f1cb3a2

diff --git a/bibisect/README.txt b/bibisect/README.txt
index 1305f03..3b2a1e3 100644
--- a/bibisect/README.txt
+++ b/bibisect/README.txt
@@ -4,6 +4,78 @@ This directory contains tools relating to the LibreOffice "Bibisect"
 QA Tool, created by Bjoern Michaelsen:
 https://wiki.documentfoundation.org/Bibisect
 
+Building a bibisect repository
+------------------------------
+
+The scripts in this directory are the primary tools for creating
+bibisect repositories. You'll want to read over these files (ignore
+mergeranges for now) to learn more about how the process works.
+
+
+  Stuff you'll need:
+  ------------------
+
+- The dev-tools repository (I assume you have it, as you're reading this)
+
+- The LibreOffice core repository
+
+  I suggest you build LibreOffice once by itself, just to make
+  sure that everything is working properly, before you jump in
+  to building a bibisect repo.
+
+- A suitable build environment
+
+- ccache
+  
+  Should be in 'ccache' package on most distros. Read this page to
+  properly configure ccache for building LibreOffice:
+  https://wiki.documentfoundation.org/Development/BuildingOnLinux#ccache
+
+
+  Getting ready:
+  --------------
+
+- Build LibreOffice
+
+- Edit bibisect.cfg to suit your particular environment:
+
+WARNING: Do not use shell expansion tricks like "~/foo" or "../blah"
+in these variables. Use full path names, please!
+
+  FROM:, TO:   These variables should be set to the start and end
+               of your range, either sha1 sums or tags.
+	       NOTE: This range is INCLUSIVE (?).
+
+               This command should return the complete list of sha1s
+               between the commits without error:
+               git rev-list --reverse <FROM>..<TO>
+
+  INTERVAL:    How many commits will be skipped between builds when
+               generating the bibisect repository, e.g. '64'
+
+  ORDERMODE:   Either 'master' or 'tags', indicating which will be
+               used in the FROM: and TO: fields.
+
+  WORKDIR:     Location of the working directory you've created for
+               building the bibisect repository, e.g. '/run/bibisect'
+
+  SOURCEREPO:  Location of the LibreOffice core repository
+  	       (I'm not sure why the .git subdir is specified, but
+	        that's the format given)
+               e.g. '/root/core/.git'
+
+  BINREPO:     I think this is the path for the actual bibisect
+               repository. This will be deleted/created during
+               the process.  (example: '/root/binrepo')
+
+  BUILDSCRIPT: Path to the buildscript. Don't touch this.
+
+  Kicking off the script
+  ----------------------
+
+It's a simple Makefile. Just run 'make' in the bibisect directory.
+
+
 
 USAGE for 'mergeranges'
 -----------------------
commit fad8b882cc9ad6c89b6148fdda7d5ab357805f79
Author: Robinson Tryon <qubit at runcibility.com>
Date:   Sun Dec 7 20:36:01 2014 -0500

    ciabot: Update documentation for install/testing
    
    This work was mostly focused on testing Bugzilla integration ahead of
    the Bugzilla Migration. Everything tests-out correctly with
    bugzilla-test.documentfoundation.org!
    
    Change-Id: Ifbf619e96fbbc2844bfa1201290855b6eb95ab89

diff --git a/ciabot/INSTALL b/ciabot/INSTALL
index a991185..6e31dd5 100644
--- a/ciabot/INSTALL
+++ b/ciabot/INSTALL
@@ -1,7 +1,23 @@
 The following steps are needed to use this code:
 
-- have this directory as e.g. ~/prod
+Install some packages:
+- Python
+  * git module (ubuntu: python-git)
+  * bugzilla module (?) (ubuntu: not in standard repos)
+- Perl
+  * WWW:Bugzilla (ubuntu: libwww-bugzilla-perl)
+  * (?) Class::MethodMaker perl module: perl-Class-MethodMaker or libclass-methodmaker-perl package
+
+Configure the software:
+- Copy config-example.cfg -> config.cfg and change the defaults
+- Copy config.pl.sample -> config.pl and change the defaults
+
+
+- Have this directory as e.g. ~/prod
+
+Clone-out extra repositories
 - git clone git://gitorious.org/irker/irker.git ~/git/irker
 - git clone git://github.com/vmiklos/irker-cia-proxy.git ~/git/irker-cia-proxy
+
+Run the install script
 - ~/git/dev-tools/ciabot/setup/install
-- Class::MethodMaker perl module: perl-Class-MethodMaker or libclass-methodmaker-perl package
diff --git a/ciabot/README b/ciabot/README
index db6ce0d..9aff640 100644
--- a/ciabot/README
+++ b/ciabot/README
@@ -8,7 +8,12 @@ output. The second starts run-libreoffice-ciabot.pl in screen.
 has an XML output, piped into irker-cia-proxy.py, which sends the info to
 irkerd.
 
+
+TESTING
+-------
+
 How to test the IRC notification part:
+--------------------------------------
 
 1) Take the IRC bot "offline", by editing ~/bin/irker-cia-proxy/projmap.json,
 e.g. redirect the channel from #libreoffice-dev to some test channel.
@@ -19,3 +24,108 @@ cd ~/libreoffice/core
 perl ~/bin/libreoffice-ciabot.pl core f9453275d2710f9d3e9a4cc1285a57db334a5e2e | (cd ~/bin/irker-cia-proxy; python irker-cia-proxy.py -s)
 
 3) Once you're happy with the result, change projmap.json back.
+
+
+How to test the Bugzilla integration:
+-------------------------------------
+
+- Follow the instructions in INSTALL to install packages and configure
+  the software.
+
+  (NOTE: It's possible that for simple testing you won't have to
+  install repos besides dev-tools and LibreOffice core. More details
+  in the future :-)
+
+- Edit file projmap.json to change the IRC channel
+
+e.g. "to": "irc://irc.freenode.net/libreoffice-dev" ->
+     "to": "irc://irc.freenode.net/libreoffice-dev-test"
+
+- Edit config.cfg to change the url for the Bugzilla install
+
+e.g. url = bugs.libreoffice.org/xmlrpc.cgi ->
+     url = bugzilla-test.documentfoundation.org/xmlrpc.cgi
+
+Don't forget to also update the user/password for connecting.
+
+- Also change the values in config.pl:
+
+Update the server, user, and password
+
+- If you don't have a LibreOffice core repo handy, clone one out
+
+https://wiki.documentfoundation.org/Development/BuildingOnLinux#Cloning_and_building
+
+- cd to the LibreOffice core repo
+
+ cd ~/libreoffice/core
+
+- Run the script:
+
+perl /path/to/dev-tools/ciabot/libreoffice-ciabot.pl core f9453275d2710f9d3e9a4cc1285a57db334a5e2e
+
+That should give you text that looks like this (abbreviated for space):
+
+ <message>
+    <generator>
+        <name>CIA Perl client for Git</name>
+        <version>1.0</version>
+    </generator>
+   ...
+ </message>
+
+If that doesn't crash, let's go further.
+
+- Make a commit in the core repo (but do NOT push it!).
+
+Reference a test bug so you don't email anyone else. Example:
+
+commit 3da8ea79e9616332fdd13a78409e963a96318428
+Author: Robinson Tryon <qubit at runcibility.com>
+Date:   Sun Dec 7 19:49:36 2014 -0500
+
+    fdo#76789 - Test Git-Bugzilla integration scripts
+    
+    Testing the integration scripts in ciabot/ to make sure that they run
+    as expected against a new server setup.
+
+- ENABLE SSL: If you're testing against one of the new TDF bugzilla
+  VMs (configured via the salt config), you'll need to enable SSL
+  by adding a 'use_ssl' line to libreoffice-bugzilla.pl:
+
+         password       => $bugzilla->{ password },
+-        bug_number     => $bugNr
++        bug_number     => $bugNr,
++        use_ssl         => 1
+     );
+
+- cd back to the LibreOffice core repo
+
+- Run the ./libreoffice-bugzilla.pl script against your new commit sha1
+
+/path/to/dev-tools/ciabot/libreoffice-bugzilla.pl core 3da8ea79e96163
+
+If the run is successful, you shouldn't see any output.
+
+- Check the bug report to confirm that the change took place.
+
+Example:
+
+  Whiteboard: target:4.4.0
+
+  Comment:
+
+  Testy Tester 2014-12-08 01:05:09 UTC
+  
+  Robinson Tryon committed a patch related to this issue.
+  It has been pushed to "master":
+  
+  http://cgit.freedesktop.org/libreoffice/core/commit/?id=3da8ea79e96163
+  
+  fdo#76789 - Test Git-Bugzilla integration scripts
+  
+  The patch should be included in the daily builds available at
+  http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
+  information about daily builds can be found at:
+  http://wiki.documentfoundation.org/Testing_Daily_Builds
+  Affected users are encouraged to test the fix and report feedback.


More information about the Libreoffice-commits mailing list