README_maintainer 7.2 KB

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