doc/release_management.txt

   1 Dieses Dokument listet die Arbeiten die für ein Lx-Office Release nötig sind,
   2 als freundliche Checkliste zum ausdrucken und erweitern.
   3
   4 0. IM VORFELD
   5 =============
   6
   7 * Etwa zwei Monate vor dem Release gibt es meistens einen Bugsprint.
   8
   9 * Nach dem Bugsprint sollten alle Bugs die noch gefixt werden müssen mit einem
  10   Target versehen werden.
  11
  12 * Neue Bugs nach dem Bugsprint werden später separat behandelt.
  13
  14 * Etwa einen Monat vor dem Release wird eine Beta herausgegeben.
  15
  16 * (TODO: Release Candidates Zeitplan).
  17
  18
  19
  20 1. KONSISTENZ DES PROGRAMMS
  21 ===========================
  22
  23 * Testlauf t/test.sh
  24
  25   - Im Moment sind 3 Fehler optimal (die sind noch nicht angegangen):
  26     o  bin/mozilla/ic.pl contains at least 130 html tags.
  27     o  bin/mozilla/ap.pl contains at least 183 html tags.
  28     o  bin/mozilla/admin.pl DOES NOT use proper system or exec calls
  29   - Einige Tests setzen eine korrekt aufgesetzte Datenbank für tests voraus.
  30     TODO: diese Tests korrekt skippen wenn keine DB gefunden wurde.
  31     TODO: Dokumeniteren wie der Releasemanager sich so eine DB baut, die
  32           sollten vor einem Release zumindest durchlaufen.
  33     TODO: Evtl eine Klasse von Releasetests einführen)
  34
  35 * Testinstallation aus dem git mit neuer auth Datenbank.
  36
  37   - Änderungen die die auth Systeme betreffen zerreissen gerne mal die initiale
  38     Installation.
  39
  40 * Testupgrade auf einer Vorversion.
  41
  42   - Dito nur mit Upgradescripten. Fehlerhafte Abhängigkeiten können dazu
  43     führen, dass Upgradescripte nicht in der richtigen Reihenfolge ausgeführt
  44     werden, was bei inkrementellem Testen nicht auffällt.
  45
  46 * Freeze auf der Mailingliste ansagen.
  47
  48   - Featurefreeze für beta
  49   - Commitfreeze für finales Release
  50
  51 * Status Bugzilla
  52
  53   - Aus dem Bugsprint sollten keine Bugs mit Target der neuen Version mehr
  54     offen sein, ist aber unrealistisch. Die noch offenen Bugs müssen bewertet
  55     werden. Kritische Bugs müssen behoben, weniger kritische evtl auf die
  56     nächste Version verschoben werden.
  57   - Neue Bugs seit dem Bugsprint müssen bewertet, gegebenenfalls behoben
  58     werden.
  59   - Sollten noch schwere Probleme existieren, Release verschieben.
  60
  61 * Changelog aktualisieren.
  62
  63   - Im Changelog sollten sämtliche behobenen Bugs seit der letzten Version
  64     aufgeführt sein.
  65
  66     Beispiel für semiautomatisches bearbeiten:
  67
  68     o Letztes Releasedatum: git log --pretty=format:%cd <release-tag> | head -1
  69     o Alle Bugs seit dem mit der Buzilla advanced search suchen:
  70       + Bugs changed
  71       + Only bugs changed between <letztes Releasedatum> and Now
  72       + where only one or more of the following changed: "Resolution"
  73       + and the new value was: "FIXED"
  74     o columns ändern auf nur "Full Summary"
  75     o copy&paste in eine Datei
  76     o perl -pale '$_="  - Bugfix $F[0]: @F[1..$#F]"' oder awk/sed drüber
  77
  78     Das gleiche für trac:
  79     o Individuelle Abfrage
  80       + geändert zwischen <letztes Releasedatum> und <heute>
  81       + Status closed
  82       + Lösung behobena
  83       + Komponente ist Lx-Office ERP
  84     o Spalten: nur Zusammenfassung
  85     o sortieren nach Ticketnummer
  86     o rest weiter ab copy&paste
  87
  88   - Ausserdem einmal durch das git scrollen und sinnvolle grössere Änderungen
  89     ins changelog übertragen. Muss nur einmal gemacht werden, möglichst danach
  90     nur noch inkrementell.
  91
  92 * Perlabhängigkeiten prüfen
  93
  94   $ scripts/find-use.pl
  95
  96   Die Ausgabe zeigt alle "use *", "use parent qw()" etc an, und
  97   sucht nach Abhängigkeiten dadrin. Achtung: require wird im Moment nicht
  98   erkannt. Die Farbcodes bedeuten:
  99
 100   grün: Alles gut, das Modul ist entweder seit Ewigkeiten im perl core, oder
 101         ist in modules/* dabei.
 102   gelb: Das Modul ist nach 5.8.0 in den core gekommen, oder steht ordnungsgemäß
 103         im InstallationCheck.pm
 104   rot:  Noch nie gesehen das Modul. muss eingepflegt werden.
 105
 106   Sollte es nicht dokumentierte Abhängigkeiten geben, muss Folgendes gemacht
 107   werden:
 108
 109   1. Wo kriegt man das Modul her?
 110     - debian paket?
 111     - cpan paket?
 112     - cpan devel version?
 113
 114   2. Welche Mindestversion funktioniert sicher?
 115     - zuindest deine aktuelle. ansonsten auch mal im cpan changelog schauen wie
 116       alt die ist, und was alles dazugekommen ist.
 117
 118   3. Das Modul in SL/InstallationCheck.pm eintragen. Testen.
 119
 120   4. Das Modul in der Installationsanleitung eintragen.
 121
 122 * doc/UPGRADE doku aktualisieren und auf Vollständigkeit prüfen.
 123
 124   Upgrade muss mindestens folgende Informationen enthalten:
 125   - Neue Pakete und Abhängigkeiten
 126   - Alles was nicht in der normalen Updatedoku steht und nötig ist, um eine
 127     Version bis zum erfolgreichen Login der neuen Version zu kriegen.
 128   - Bekannte Probleme die im testing auftraten dokumentieren.
 129
 130 * doc/Lx-Office-Dokumentation.pdf erstellen
 131  (TODO: commands)
 132
 133 * scripts/rose_auto_create_model.pl update machen.
 134
 135   Das ist nicht ganz einfach, dafür gibt es keinen einfachen Knopf. Folgende
 136   Constraints sollten eingehalten werden:
 137
 138   - Alle Datenbank Upgrades seit der letzten Version müssen eingepflegt werden.
 139   - Alle noch nicht normalisierten Tabellen müssen weiterhin ignoriert werden.
 140   - Alle Felder die von der crm, von bob, von lx-cars oder sonstwo in die
 141     Datenbank gekommen sind, müssen ignoriert werden.
 142   - Wenn die Reihenfolge der Spalten in der Datenbank moniert wird, dann sollte
 143     das auch ignoriert werden. (Kann passieren, wenn DB Upgrades in
 144     verschiedener Reihenfolge eingespielt werden.)
 145   - Wenn Metastatements dazukommen, wie zum Beispiel
 146     "allow_inline_column_values => 1," dann ist die Ausgabe der neusten
 147     Rose::DB::Object Version zu wählen die kompatibel zu älteren Versionen
 148     bleibt.
 149
 150   Zum Prüfen was sich geändert hat eignen sich folgende Befehle:
 151
 152   # listet alle Dateien in denen sich etwas Ändern würde
 153   $ scripts/rose_auto_create_model.pl --user=<login> -n --all
 154
 155   # listet die entsprechenden Diffs:
 156   $ scripts/rose_auto_create_model.pl --user=<login> --diff -n --all
 157
 158 * Locales auf Vollständigkeit prüfen
 159
 160   $ scripts/locales.pl de
 161
 162 * SL::DB::Helper::ALL auf Vollständigkeit prüfen
 163
 164   (TODO: Mag da einer ein Script für schreiben?
 165      find SL/DB -type f | grep -v MetaSetup | grep -v Helper | grep -v Manager | sort
 166    hilft, kriegt aber die Sortierung durcheinander)
 167
 168 * VERSION updaten
 169
 170   Zu den Versionierungen:
 171
 172   - Das Programm heißt Lx-Office (großes LO, mit Bindestrich dazwischen)
 173   - Das Paket heißt lx-office-erp (klein, plus "-erp")
 174   - Der Standardpfad ist lxoffice-erp-<version> (fehlender Bindestrich)
 175   - Der git tag ist "release-<version>"
 176   - Das DB Ipgradescript ist "release_<snake_case_version>"
 177
 178 * Nur finales Release: Datenbankupgradescript "release_2_6_1" (mit aktueller
 179   Releasenummer) erstellen und alle Leafscripte als Abhängigkeit einsetzen.
 180   Leafscripte kriegt man mit
 181
 182   $ scripts/dbupgrade2_tool.pl --nodeps
 183
 184 * Voraussichtliches Releasedatum im changelog eintragen
 185
 186 * Finaler Testlauf:
 187
 188   t/test.sh
 189
 190   Siehe oben für mögliche Ergebnisse.
 191
 192 * Alle Änderungen einchecken.
 193
 194
 195
 196 2. RELEASE
 197 ==========
 198
 199 * Annotated tag erstellen und pushen
 200
 201   $ git tag -a release-2.6.1
 202   $ git push origin tags/release-2.6.1
 203
 204 * Tarball erstellen
 205
 206   $ git archive --format=tar --remote=<master repo>        \
 207         --prefix=lxoffice-erp-2.6.1/ release-2.6.1 | gzip  \
 208         > lx-office-erp-2.6.1.tar.gz
 209
 210   (der trailing slash bei prefix ist wichtig)
 211
 212 * Tarball testen, wird das richtig entpackt?
 213
 214 * SHA1 und MD5 von tarball machen und in *.sha1 bzw. *.md5 speichern
 215
 216 * Alles auf Sourceforge hochladen
 217
 218 * Auf Sourceforge den Standarddownloadlink setzen
 219
 220 * Releasemessages schreiben für folgende Ziele:
 221
 222   - lx-office.org: deutsch, prosa, formell
 223   - freecode.com: englisch, max 600 zeichen, technische stichpunkte aus dem changelog (ehemals freshmeat.net)
 224   - mailinglisten: deutsch, freitext, informell
 225
 226 * Alle Releasemessages von mindestens einer Person Korrektur lesen lassen
 227
 228 * Webseite aktualisieren, Releasemessages auf freecode und Mailinglisten posten
 229
 230
 231 3. POST RELEASE
 232 ===============
 233
 234 * Im Bugzilla die aktuelle Version ergänzen, damit dafür Bugs eingespielt werden können.
 235
 236 * Nach einem Major Release alle Bugs die den Milestone hatten und nicht gefixt wurden zurücksetzen