README_maintainer 6.5 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: =9.1=
  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: =9.1.7=
  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_9.1.7 -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_9.1.7 -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 files, the documentation, and to upload
  48. 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 Org and upstream Emacs
  57. Below it is described how Org is kept in sync with the upstream Emacs.
  58. ** Backporting changes from upstream Emacs
  59. Sometimes Emacs maintainers make changes to Org files. The process of
  60. propagating the changes back to the Org repository is called
  61. /backporting/ for historical reasons.
  62. To find changes that need to be backported from the Emacs repository,
  63. the following =git= command, courtesy of [[][Kyle Meyer]], can be used:
  64. #+begin_src shell
  65. git log $rev..origin/emacs-25 -- lisp/org doc/misc/org.texi \
  66. etc/refcards/orgcard.tex etc/ORG-NEWS etc/org \
  67. etc/schema/od-manifest-schema-v1.2-os.rnc \
  68. etc/schema/od-schema-v1.2-os.rnc
  69. #+end_src
  70. here, =$rev= is the last commit from the =emacs-25= branch that was
  71. backported. The should also be done for the =master= branch.
  72. There is also a [[][feed]] to keep track of new changes in the =lisp/org=
  73. folder in the Emacs repository.
  74. ** Updating the Org version in upstream Emacs
  75. New releases of Org should be added to the [[][Emacs repository]].
  76. Typically, Org can be synchronized by copying over files from the
  77. =emacs-sync= branch of the Org repository to the =master= branch of Emacs
  78. repository. The =emacs-sync= branch has a few extra changes compared
  79. with the =maint= branch. If the Emacs maintainers are planning a new
  80. release of Emacs soon, it is possible that another branch should be
  81. used.
  82. If the new release of Org contains many changes, it may be useful to
  83. use a separate branch before merging, e.g. =scratch/org-mode-merge=.
  84. This branch can then be merged with the =master= branch, when everything
  85. has been tested.
  86. Please see [[][CONTRIBUTE]] in the Emacs repository for guidelines on
  87. contributing to the Emacs repository.
  88. *** Where to files go
  89. The following list shows where files in Org repository are copied to
  90. in the Emacs repository, folder by folder.
  91. **** =org-mode/doc=
  92. - =org.texi= :: Copy to =emacs/doc/misc=. It may be necessary to replace,
  93. ~@include with ~@set VERSION 9.0.9~ or similar.
  94. - =orgcard.tex= :: Copy to =emacs/etc/refcards=. Make sure that
  95. ~\def\orgversionnumber~ and ~\def\versionyear~ are up to date.
  96. **** =org-mode/etc=
  97. - =styles/*= :: Copy to =emacs/etc/org=.
  98. - =schema/*.rnc= :: Copy to =emacs/etc/schema=.
  99. - =schema/schemas.xml= :: Any new entries in this file should be added
  100. to =emacs/etc/schema/schemas.xml=.
  101. - =ORG-NEWS= :: Copy to =emacs/etc=
  102. **** =org-mode/lisp=
  103. - Copy =*.el= files to =emacs/lisp/org=, except =org-loaddefs.el=!
  104. - You should create =org-version.el= in =emacs/lisp/org=. The file is
  105. created when you =make= Org.
  106. **** TODO =org-mode/testing=
  107. *** Update =emacs/etc/NEWS=
  108. Whenever a new (major) version of Org is synchronized to the Emacs
  109. repository, it should be mentioned in the NEWS file.
  110. * Updating the list of hooks/commands/options on Worg
  111. Load the =mk/eldo.el= file then =M-x eldo-make-doc RET=.
  112. This will produce an org file with the documentation.
  113. Import this file into =worg/, leaving the header untouched
  114. (except for the release number).
  115. Then commit and push the change on the =worg.git= repository.
  116. * Copyright assignments
  117. The maintainer needs to keep track of copyright assignments. Even
  118. better, find a volunteer to do this.
  119. The assignment form is included in the repository as a file that you
  120. can send to contributors: =request-assign-future.txt=
  121. The list of all contributors from who we have the papers is kept on
  122. Worg at, so that
  123. committers can check if a patch can go into the core.
  124. The assignment process does not allways go smoothly, and it has
  125. happened several times that it gets stuck or forgotten at the FSF.
  126. The contact at the FSF for this is:
  127. Emails from the paper submitter have been ignored in the past, but an
  128. email from me (Carsten) as the maintainer of Org mode has usually
  129. fixed such cases within a few days.