README_maintainer

   1 # -*- mode:org -*-
   2
   3 #+TITLE: Org maintainer tasks
   4 #+STARTUP: noindent
   5
   6 This document describes the tasks the Org-mode maintainer has to do
   7 and how they are performed.
   8
   9 * Git workflow
  10
  11 The git repository has two branches:
  12
  13 - master :: for current development.
  14
  15 - maint :: for bug fixes against latest major or minor release.
  16
  17 Bug fixes always go on =maint= then are merged on =master=.
  18
  19 New features always go on =master=.
  20
  21 * Releasing
  22
  23 ** Major release
  24
  25 The release number for main releases look like this: =7.13=
  26
  27 Main releases are made whenever Org is in a state where the feature
  28 set is consistent and we feel that the features that are implemented
  29 is something we want to support in the future.
  30
  31 A major release turns the current state of the master branch into a
  32 release.
  33
  34 When doing a /major release/, make sure all changes from the maint
  35 branch are merged into the the master branch, then merge the master
  36 branch back into maint to synchronize the two.
  37
  38 ** Minor release
  39
  40 The release number for minor releases look like this:  =7.13.1=
  41
  42 Minor releases are small amends to main releases.  Usually they fix
  43 critical bugs discovered in a main release.  Minor bugs are usually
  44 not fixed -- they will be adressed in the next main release.
  45
  46 Only the fix to the bug is bundled into a release, without the main
  47 development work going on in the master branch.  Since the bug fix
  48 will also be needed in the master branch, usually the fix is made in
  49 maint then merged in master.
  50
  51 ** Tagging the release
  52
  53 When doing a major and a minor release, after all necessary merging is
  54 done, tag the _maint_ branch for the release with:
  55
  56   git tag -a "Adding release tag" release_7.9.1
  57
  58 and push tags with
  59
  60   git push --tags
  61
  62 We also encourage you to sign release tags like this:
  63
  64   git tag -a "Adding release tag" -s release_7.9.1
  65
  66 ** Uploading the release files from the orgmode.org server
  67
  68 Log on the orgmode.org server as the emacs user and cd to
  69 ~/git/org-mode
  70
  71 From there do
  72
  73   make release
  74   make upload
  75
  76 to create the .tar.gz and .zip files, the documentation, and to
  77 upload everything at the right place.
  78
  79 * Synchonization with Emacs
  80
  81 This is still a significant headache.  Some hand work is needed here.
  82
  83 Emacs uses bzr.  A useful introduction to bzr for Emacs developers can
  84 be found [[http://www.emacswiki.org/emacs/BzrForEmacsDevs][here]].  While I see all the advantages this would have, I
  85 cannot bring myself to switch away from git for my day-to-day work,
  86 because I know git so well, and because git seems to me as being much
  87 more powerful, conceptionally simple (once you have [[http://newartisans.com/2008/04/git-from-the-bottom-up/][bent your head
  88 around it]]), and so much faster.
  89
  90 So the way I have been doing things with Emacs is this:
  91
  92 1. I do not update the version in Emacs too often.  Just once every
  93    few months - this is frequently enough for the Emacs release cycle.
  94    Care must be taken to get in a *new and stable* version shortly
  95    before Emacs goes into feature freeze and pretest, because that
  96    version is going to be in the wild for a long time.
  97
  98 2. I watch the Emacs diffs for changes made by the maintainers of
  99    Emacs in the org-mode files in Emacs.  Any changes that come up
 100    there, I merge into the development version of Org-mode.
 101    Occasionally I do not do this, if I do not agree with a change.
 102    The changes go into Org /without/ a ChangeLog-like entry in the
 103    commit message.  The reason for this is that we will later generate
 104    a ChangeLog file from our commit messages, and I do not want double
 105    ChangeLog entries in the Emacs ChangeLog file.
 106
 107 3. When I have made a release (usually I wait for the minor releases
 108    to stabilize), I *copy* org files into the Emacs repository.  Yes,
 109    I do not merge, I copy.  This has been the source of some problems
 110    in the past - Emacs developers are not happy when I accidentally
 111    overwrite changes they made.  But I have not had the patience to
 112    work out a better mechanism, and I really dislike the idea that the
 113    version in Emacs starts diverging from my own.
 114
 115    Careful: Copy /org.texi/ and /orgcard.tex/ into the right places,
 116    and also copy the lisp files with *two exceptions*: Do *not* copy
 117    /org-colview-xemacs.el/ and /org-loaddefs.el/.  The former does not
 118    belong in Emacs.  And the latter would actually be harmful because
 119    Emacs generates its own autoloads.
 120
 121 4. Generate the ChangeLog entries
 122
 123    For this, I do in the org-mode git repository
 124
 125    : mk/make_emacs_changelog release_7.02.05..release_7.03.02
 126
 127    This will spit out ChangeLog entries (for the given commit range)
 128    that need to go into the ChangeLog files in Emacs.  Org-mode
 129    contributes to 3 different ChangeLog files in Emacs:
 130
 131    : lisp/org/ChangeLog    (for lisp changes)
 132    : doc/misc/ChangeLog    (for org.texi changes)
 133    : etc/ChangeLog         (for refcard changes)
 134
 135    When you run the =make_emacs_changelog= program, you will be
 136    prompted for a date in ISO format YYYY-MM-DD, this date will be
 137    used in the ChangeLog entries - Emacs developers want these dates
 138    to be the time when the change has been installed into Emacs, not
 139    the time when we made the change in our own repository.  So all the
 140    ChangeLog entries will get the same date.  You will also be
 141    prompted for the kind of ChangeLog you want to make, possible
 142    answers are =lisp=, =texi=, and =card=.  The program will then
 143    select the correct entries for the specified ChangeLog file.  If
 144    you don't like being prompted, you can give the date and type as
 145    second and third command line arguments to =make_emacs_changelog=,
 146    for example
 147
 148    : mk/make_emacs_changelog release_7.02.05..release_7.03.02 2010-12-11 lisp
 149
 150    These entries need to be added to the ChangeLog files in Emacs.
 151    You should, in the ChangeLog file, select the inserted region of
 152    new entries and do =M-x fill-region=, so that the entries are
 153    formatted correctly.  I then do look through the entries quickly to
 154    make sure they are formatted properly, that the email addresses
 155    look right etc.
 156
 157 5. Commit the changes into the bzr repository and you are done.  Emacs
 158    developers often look throught the commit and make minor changes -
 159    these need to be merged back into our own repo.
 160
 161 * Updating the list of hooks/commands/options on Worg
 162
 163   Load the =mk/eldo.el= file then =M-x eldo-make-doc RET=.
 164
 165   This will produce an org file with the documentation.
 166
 167   Import this file into =worg/doc.org=, leaving the header untouched
 168   (except for the release number).
 169
 170   Then commit and push the change on the =worg.git= repository.
 171
 172 * Copyright assignments
 173
 174   The maintainer needs to keep track of copyright assignments.
 175   Even better, find a volunteer to do this.
 176
 177   The assignment form is included in the repository as a file that
 178   you can send to contributors: =request-assign-future.txt=
 179
 180   The list of all contributors from who we have the papers is kept on
 181   Worg at http://orgmode.org/worg/org-contribute.html, so that
 182   committers can check if a patch can go into the core.
 183
 184   The assignment process does not allways go smoothly, and it has
 185   happened several times that it gets stuck or forgotten at the FSF.
 186   The contact at the FSF for this is: mailto:copyright-clerk@fsf.org
 187
 188   Emails from the paper submitter have been ignored in the past, but
 189   an email from me (Carsten) as the maintainer of Org mode has usually
 190   fixed such cases within a few days.