annotate README @ 440:383d23c6bfde

Merged revisions 346-386 via svnmerge from svn+ssh://svn.wald.intevation.org/treepkg/branches/treepkg-status ........ r346 | bricks | 2010-07-07 17:40:48 +0200 (Mi, 07 Jul 2010) | 2 lines added classed for treepkg status xml generation ........ r347 | bricks | 2010-07-08 12:07:39 +0200 (Do, 08 Jul 2010) | 10 lines renamed new status dir to info because of a naming conflict with status.py let the user specify a treepkg name in the config the name is propagated to PackagerGroup [treepkg] name: <treepkgname> becomes: pg = PackagerGroup(...) pg.name ........ r348 | bricks | 2010-07-08 15:25:07 +0200 (Do, 08 Jul 2010) | 3 lines moved test file to test main dir fixed missing : after def statement ........ r349 | bricks | 2010-07-08 17:59:52 +0200 (Do, 08 Jul 2010) | 2 lines added treepkg_dir andd tracks_dir attributes to PackageGroup ........ r350 | bricks | 2010-07-08 18:00:32 +0200 (Do, 08 Jul 2010) | 2 lines changed <millpath> to <trackspath> ........ r351 | bricks | 2010-07-08 18:08:39 +0200 (Do, 08 Jul 2010) | 2 lines check if config file exists to get usefull error output ........ r352 | bricks | 2010-07-08 18:11:13 +0200 (Do, 08 Jul 2010) | 2 lines write first info about tracks ........ r353 | bricks | 2010-07-09 12:20:49 +0200 (Fr, 09 Jul 2010) | 2 lines get all log files ........ r354 | bricks | 2010-07-09 14:42:42 +0200 (Fr, 09 Jul 2010) | 2 lines added md5sum function ........ r355 | bricks | 2010-07-09 15:15:15 +0200 (Fr, 09 Jul 2010) | 4 lines implemented nearly all info only arch and os info are missing ........ r356 | bricks | 2010-07-09 16:19:17 +0200 (Fr, 09 Jul 2010) | 2 lines Bugfix: source was not defined ........ r357 | bricks | 2010-07-09 16:44:52 +0200 (Fr, 09 Jul 2010) | 3 lines fixed some typos added missing add_checksum methond ........ r358 | bricks | 2010-07-09 17:06:15 +0200 (Fr, 09 Jul 2010) | 2 lines fixed status line for revision ........ r359 | bricks | 2010-07-12 14:10:34 +0200 (Mo, 12 Jul 2010) | 2 lines let the user specify num revisions that should be shown in the info ........ r360 | bricks | 2010-07-12 14:21:39 +0200 (Mo, 12 Jul 2010) | 2 lines missed in last commit ........ r361 | bricks | 2010-07-12 17:06:22 +0200 (Mo, 12 Jul 2010) | 2 lines add os config statement ........ r362 | bricks | 2010-07-12 17:47:42 +0200 (Mo, 12 Jul 2010) | 3 lines moved packages and logs to revision tag implemented os and arch info ........ r363 | bricks | 2010-07-13 14:23:28 +0200 (Di, 13 Jul 2010) | 2 lines updated test readconfig for os config variable ........ r364 | bricks | 2010-07-13 14:24:14 +0200 (Di, 13 Jul 2010) | 2 lines moved common publish functions to a seperate module ........ r365 | bricks | 2010-07-13 16:26:11 +0200 (Di, 13 Jul 2010) | 2 lines moved arch info to each package info ........ r366 | bricks | 2010-07-13 18:46:17 +0200 (Di, 13 Jul 2010) | 2 lines inital checkin for new publishpackages processing ........ r367 | bricks | 2010-07-21 17:52:15 +0200 (Mi, 21 Jul 2010) | 2 lines implemented parsing from xml string ........ r368 | bricks | 2010-07-22 12:17:42 +0200 (Do, 22 Jul 2010) | 2 lines copy binary-all packages in all binary-xyz dirs ........ r369 | bricks | 2010-07-22 12:26:40 +0200 (Do, 22 Jul 2010) | 2 lines fixed small bugs ........ r370 | bricks | 2010-07-22 13:02:36 +0200 (Do, 22 Jul 2010) | 2 lines added a new root element which is called TreepkgRoot for Treepkg Info classes ........ r371 | bricks | 2010-07-22 13:09:52 +0200 (Do, 22 Jul 2010) | 3 lines fixed some small issues remember: run pychecker BEFORE the commit ........ r372 | bricks | 2010-07-22 18:01:43 +0200 (Do, 22 Jul 2010) | 2 lines improved publishdebianpackages and fixed a lot of bugs in the xml info parsing part ........ r373 | bricks | 2010-07-23 18:40:38 +0200 (Fr, 23 Jul 2010) | 2 lines implemented CacheDb to store copied Packages from build host ........ r374 | bricks | 2010-07-26 10:28:48 +0200 (Mo, 26 Jul 2010) | 2 lines moved data handling in publishdebianpackages into seperate module ........ r375 | bricks | 2010-07-26 11:42:07 +0200 (Mo, 26 Jul 2010) | 2 lines fixed some typos ........ r376 | bricks | 2010-07-26 12:12:40 +0200 (Mo, 26 Jul 2010) | 2 lines first version of incremental copying debian packages to cachedir ........ r377 | bricks | 2010-07-26 14:58:50 +0200 (Mo, 26 Jul 2010) | 2 lines incremental copying only changed debian packages ........ r378 | bricks | 2010-07-26 15:39:10 +0200 (Mo, 26 Jul 2010) | 3 lines use md5 instead of hashlib module (md5 is deprecated in favour of hashlib in python 2.5) ........ r379 | bricks | 2010-07-26 15:46:19 +0200 (Mo, 26 Jul 2010) | 2 lines make treepkg compatible to python 2.4 ........ r380 | bricks | 2010-07-26 15:50:49 +0200 (Mo, 26 Jul 2010) | 2 lines fixed last commit (db instead of sqlite3) ........ r381 | bricks | 2010-07-27 10:54:15 +0200 (Di, 27 Jul 2010) | 2 lines fixed wrong import statement ........ r382 | bricks | 2010-07-27 10:54:34 +0200 (Di, 27 Jul 2010) | 2 lines removed unnecessary debug output ........ r383 | bricks | 2010-07-27 18:28:22 +0200 (Di, 27 Jul 2010) | 2 lines check if upload hook is empty ........ r384 | bricks | 2010-07-28 09:35:21 +0200 (Mi, 28 Jul 2010) | 2 lines run rsync only an arch dirs that are present in the current treepkg ........ r385 | bricks | 2010-07-28 09:35:54 +0200 (Mi, 28 Jul 2010) | 2 lines add helper tool to list content of a cache db ........ r386 | bricks | 2010-07-28 10:33:48 +0200 (Mi, 28 Jul 2010) | 3 lines fixed a typo regex fails if option is empty ........
author Bjoern Ricks <bricks@intevation.de>
date Fri, 06 Aug 2010 13:28:47 +0000
parents 092925ff75d7
children
rev   line source
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
1 README for TreePackager
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
2 =======================
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
3
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
4
321
092925ff75d7 Added basic Git support, configuration options:
Andre Heinecke <aheinecke@intevation.de>
parents: 109
diff changeset
5 TreePackager is a tool to automatically build debian packages.
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
6
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
7
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
8 Prerequisites
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
9 -------------
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
10
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
11 You need the following software to run TreePackager. In the list below,
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
12 parentheses contain the name of the corresponding package in Debian Etch
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
13 if its not the same as the software. The version required is usually
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
14 the one from debian etch.
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
15
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
16 Python 2.4 (python2.4-minimal)
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
17 Debian devscripts (devscripts)
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
18 subversion
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
19 pbuilder
321
092925ff75d7 Added basic Git support, configuration options:
Andre Heinecke <aheinecke@intevation.de>
parents: 109
diff changeset
20 git-core
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
21 sudo
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
22 bzip2
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
23
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
24 For the web front-end you also need the following software:
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
25
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
26 Genshi (python-genshi)
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
27 CherryPy (python-cherrypy)
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
28
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
29 Some of the packagers require additional software. The KDEPIM
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
30 enterprise branch packagers require the following additional software:
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
31
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
32 autoconf2.13
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
33 automake1.9
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
34
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
35
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
36 Installation
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
37 ------------
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
38
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
39 You can run the tree packager itself directly from the source tree.
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
40 However, you need to configure it first and setup pbuilder.
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
41
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
43 Configuration
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
44 -------------
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
45
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
46 To understand the configuration, first a few notes about the
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
47 architecture of TreePackager. The TreePackager consist of one program
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
48 that periodically updates svn working directories and if something has
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
49 changed, builds a new debian package from the working directory. The
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
50 program should run as a normal user. The sample configuration assumes
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
51 that it's the user "builder" with a home directory "/home/builder". The
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
52 default configuration manages a directory tree under
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
53 "/home/builder/enterprise".
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
54
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
55 The binary packages are built with pbuilder. Because pbuilder uses a
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
56 chroot environment to build the packages, it must be run as root. The
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
57 tree packager therefore needs a way to run pbuilder as root even though
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
58 itself runs as a non-root user. By default the tree packager uses sudo,
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
59 so you have to setup sudo to allow the tree packager user to invoke
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
60 pbuilder without a password. This can be accomplished with the
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
61 following line in /etc/sudoers (using the default user name):
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
62
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
63 builder ALL = NOPASSWD: /usr/sbin/pbuilder
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
64
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
65
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
66 Configure TreePackager
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
67 ~~~~~~~~~~~~~~~~~~~~~~
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
68
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
69 The file demo.cfg contains example configuration that contains most of
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
70 what is needed to package KDEPIM and kde-i18n from the KDEPIM enterprise
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
71 branch. Copy this file to treepkg.cfg and adapt it to your needs. The
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
72 comments in the file should provide most of the hints to get you
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
73 started. Some more information is in the "Configuring a packager"
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
74 section below.
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
75
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
76
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
77 Configuring a packager
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
78 ~~~~~~~~~~~~~~~~~~~~~~
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
79
73
26a617c0f76b fix typo
Bernhard Herzog <bh@intevation.de>
parents: 72
diff changeset
80 The configuration file contains one section for each packager. The
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
81 section name starts with a "pkg_" prefix. The possible options are
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
82 described in demo.cfg. However there are some things that need to be
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
83 set up outside of the config file.
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
84
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
85 Each packager has a base directory (the base_dir option in the
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
86 corresponding pkg_-section). One thing needed by a packager is the
72
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
87 contents of the debian sub-directory of the debian source package. When
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
88 creating the source package, the packager simply copies the
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
89 sub-directory "debian" of the base_dir into the directory making up the
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
90 source tree. How the debian directory is created and maintained is up
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
91 to you. Usually it's a good idea to start with the debian sub-directory
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
92 an existing debian package for the software.
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
93
108
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
94 Once you have configured the packagers, you can create their directories
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
95 with
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
96
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
97 bin/inittreepkg.py
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
98
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
99 This will create base directories of each packager and report some
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
100 missing steps that will have to be done manually, like creating a debian
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
101 subdirectory with the debian packaging information.
91deff3db739 Add note about bin/inittreepkg.py to README
Bernhard Herzog <bh@intevation.de>
parents: 78
diff changeset
102
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
103
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
104 Configure pbuilder
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
105 ~~~~~~~~~~~~~~~~~~
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
106
50
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
107 It's best to give the tree packager its own pbuilder configuration and
72
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
108 directories. The default configuration uses a "pbuilder" sub-directory
50
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
109 in /home/builder/enterprise. If you have created the treepkg.cfg file
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
110 with at least one packager and the correct root_cmd and pbuilderrc
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
111 options (the defaults for both should be OK if you use sudo as described
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
112 above), you can create the directories, the pbuilder configuration and
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
113 the chroot environment with the script initpbuilder.py like this:
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
114
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
115 bin/initpbuilder.py --mirrorsite=<URL of preferred debian mirror>
50
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
116
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
117 You can specify some more mirrors with the --othermirror option. For
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
118 more information run "bin/initpbuilder.py --help" and consult the pbuilder
50
225206553bba update README part about pbuilder config
Bernhard Herzog <bh@intevation.de>
parents: 42
diff changeset
119 documentation.
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
120
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
121
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
122 Configure the web front-end
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
124
70
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
125 The web front-end consists of a single HTML-page with an overview of the
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
126 packager status and links to build logs when available. There are two
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
127 ways to publish this front-end: as little web-server with a dynamic
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
128 web-page or as a directory with a bunch of files making up a static
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
129 web-site.
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
130
72
7e6da00cccef fix typos in README
Bernhard Herzog <bh@intevation.de>
parents: 71
diff changeset
131 Web-server:
70
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
132
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
133 The default configuration should be OK in most cases. If you want you
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
134 can customize it in cherrypy.cfg. Start the web front-end with
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
135
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
136 bin/starttreepkgweb.py
42
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
137
bad59cd04f34 add README
Bernhard Herzog <bh@intevation.de>
parents:
diff changeset
138 starttreepkgweb has some options to specify which configuration files to use.
70
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
139
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
140
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
141 Static pages:
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
142
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
143 The static pages are published using two programs, createstaticweb.py
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
144 and publishstaticweb.py. createstaticweb.py is run on the system where
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
145 the tree packager runs. publishstaticweb.py is usually run on another
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
146 system and connects via ssh and rsync to the tree packager host, creates
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
147 the files with createstaticweb.py and copies the files from the tree
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
148 packager host to a third host.
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
149
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
150 The configuration file for publishstaticweb.py is demostaticweb.cfg.
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
151 Copy this file to staticweb.cfg and adapt it to your system. The
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
152 comments in the file describe the options. Afterwards, run the script
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
153 with
70
4b537aadc5ce add README section for the static web-page config
Bernhard Herzog <bh@intevation.de>
parents: 69
diff changeset
154
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
155 bin/publishstaticweb.py
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
156
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
157
109
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
158 Notification Mails
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
159 ~~~~~~~~~~~~~~~~~~
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
160
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
161 The tree packager can send notification mails when a built fails. This
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
162 works in a two-step process like the creation of the static web-pages.
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
163 The sample configuration file for the notification mails is
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
164 demonotification.cfg. Copy it to notification.cfg and adapt it to your
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
165 needs. The comments in the file describe the options. In particular
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
166 you will want to customize the template for the notification mail to
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
167 include suitable email addresses. To actually send notifications, run
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
168
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
169 bin/sendnotificationmails.py
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
170
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
171 Note that this only tries to send mails when a build has failed.
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
172
fbfa1abb47f1 Add note about notificatin mails to README
Bernhard Herzog <bh@intevation.de>
parents: 108
diff changeset
173
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
174 Running the Tree Packager
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
175 -------------------------
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
176
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
177 After configuration, run the tree packager with
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
178
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
179 bin/runtreepkg.py [options] [packager...]
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
180
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
181 For each packager listed on the command line -- or all configured
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
182 packagers if none are given -- the tree packager checks out or updates
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
183 the sources and builds binary packages if the new revision hasn't been
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
184 packaged yet.
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
185
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
186 If the option --once has been given, the tree packager exits after it
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
187 has checked each packager once. Without it, the check is done
78
9a602d8eaa60 initial revision of the subversion repository
Thomas Arendsen Hein <thomas@intevation.de>
parents: 73
diff changeset
188 repeatedly. The interval between two checks can be set in the configuration
71
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
189 file.
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
190
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
191 Call runtreepkg.py with the --help option to see a list of the available
2eefd12526ff flesh out the REAME file some more
Bernhard Herzog <bh@intevation.de>
parents: 70
diff changeset
192 options.
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)