README_maintainer 8.0 KB

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