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