README_maintainer

   1 # -*- mode:org -*-
   2
   3 #+TITLE: Org maintainer tasks
   4 #+STARTUP: noindent
   5 #+OPTIONS: ^:nil
   6
   7 This document describes the tasks the Org-mode maintainer has to do
   8 and how they are performed.
   9
  10 * Git workflow
  11
  12 The git repository has two branches:
  13
  14 - master :: for current development.
  15
  16 - maint :: for bug fixes against latest major or minor release.
  17
  18 Bug fixes always go on =maint= then are merged on =master=.
  19
  20 New features always go on =master=.
  21
  22 * Releasing
  23
  24 ** Major release
  25
  26 The release number for main releases look like this: =7.13=
  27
  28 Main releases are made whenever Org is in a state where the feature
  29 set is consistent and we feel that the features that are implemented
  30 is something we want to support in the future.
  31
  32 A major release turns the current state of the master branch into a
  33 release.
  34
  35 When doing a /major release/, make sure all changes from the maint
  36 branch are merged into the the master branch, then merge the master
  37 branch back into maint to synchronize the two.
  38
  39 ** Minor release
  40
  41 The release number for minor releases look like this:  =7.13.1=
  42
  43 Minor releases are small amends to main releases.  Usually they fix
  44 critical bugs discovered in a main release.  Minor bugs are usually
  45 not fixed -- they will be adressed in the next main release.
  46
  47 Only the fix to the bug is bundled into a release, without the main
  48 development work going on in the master branch.  Since the bug fix
  49 will also be needed in the master branch, usually the fix is made in
  50 maint then merged in master.
  51
  52 ** Tagging the release
  53
  54 When doing a major and a minor release, after all necessary merging is
  55 done, tag the _maint_ branch for the release with:
  56
  57   git tag -a release_7.9.1 -m "Adding release tag"
  58
  59 and push tags with
  60
  61   git push --tags
  62
  63 We also encourage you to sign release tags like this:
  64
  65   git tag -s release_7.9.1 -m "Adding release tag"
  66
  67 ** Uploading the release files from the orgmode.org server
  68
  69 Log on the orgmode.org server as the emacs user and cd to
  70 ~/git/org-mode
  71
  72 From there do
  73
  74   make release
  75   make upload
  76
  77 to create the .tar.gz and .zip files, the documentation, and to
  78 upload everything at the right place.
  79
  80 * Available Org's builds on the server
  81
  82 There are two cron tasks on the server: one that builds the ELPA
  83 packages and one that builds org-latest.tar.gz and org-latest.zip.
  84
  85 ELPA packages are built from the *maint* branch.  One ELPA package
  86 contains Org's core, another one called "org-plus-contrib" contains
  87 Org and contributed libraries.
  88
  89 org-latest* snapshots are built from the *master* branch.
  90
  91 * Synchronization Org and upstream Emacs
  92
  93 Below it is described how Org is kept in sync with the upstream Emacs.
  94
  95 ** Backporting changes from upstream Emacs
  96
  97 Sometimes Emacs maintainers make changes to Org files.  The process of
  98 propagating the changes back to the Org repository is called
  99 /backporting/ for historical reasons.
 100
 101 To find changes that need to be backported from the Emacs repository,
 102 the following =git= command, courtesy of [[http://permalink.gmane.org/gmane.emacs.devel/215861][Kyle Meyer]], can be used:
 103
 104 #+begin_src shell
 105   git log $rev..origin/emacs-25 -- lisp/org doc/misc/org.texi \
 106     etc/refcards/orgcard.tex etc/ORG-NEWS etc/org \
 107     etc/schema/od-manifest-schema-v1.2-os.rnc \
 108     etc/schema/od-schema-v1.2-os.rnc
 109 #+end_src
 110
 111 here, =$rev= is the last commit from the =emacs-25= branch that was
 112 backported.  The should also be done for the =master= branch.
 113
 114 There is also a [[http://git.savannah.gnu.org/cgit/emacs.git/atom/lisp/org/][feed]] to keep track of new changes in the =lisp/org=
 115 folder in the Emacs repository.
 116
 117 ** Updating the Org version in upstream Emacs
 118
 119 New releases of Org should be added to the [[https://git.savannah.gnu.org/cgit/emacs.git][Emacs repository]].
 120
 121 Typically, Org can be synchronized by copying over files from the
 122 =emacs-sync= branch of the Org repository to the =master= branch of Emacs
 123 repository.  The =emacs-sync= branch has a few extra changes compared with
 124 the =maint= branch.  If the Emacs maintainers are planning a new release
 125 of Emacs soon, it is possible that another branch should be used.
 126
 127 If the new release of Org contains many changes, it may be useful to
 128 use a separate branch before merging, e.g. =scratch/org-mode-merge=.
 129 This branch can then be merged with the =master= branch, when everything
 130 has been tested.
 131
 132 Please see [[http://git.savannah.gnu.org/cgit/emacs.git/tree/CONTRIBUTE][CONTRIBUTE]] in the Emacs repository for guidelines on
 133 contributing to the Emacs repository.
 134
 135 *** Where to files go
 136
 137 The following list shows where files in Org repository are copied to in
 138 the Emacs repository, folder by folder.
 139
 140 **** =org-mode/doc=
 141
 142 - =org.texi= :: Copy to =emacs/doc/misc=.  It may be necessary to replace,
 143      ~@include org-version.inc~ with ~@set VERSION 9.0.9~ or similar.
 144
 145 - =orgcard.tex= :: Copy to =emacs/etc/refcards=.  Make sure that
 146      ~\def\orgversionnumber~ and ~\def\versionyear~ are up to date.
 147
 148 ****  =org-mode/etc=
 149
 150 - =styles/*= :: Copy to =emacs/etc/org=.
 151
 152 - =schema/*.rnc= :: Copy to =emacs/etc/schema=.
 153
 154 - =schema/schemas.xml= :: Any new entries in this file should be added
 155      to =emacs/etc/schema/schemas.xml=.
 156
 157 - =ORG-NEWS= :: Copy to =emacs/etc=
 158
 159 **** =org-mode/lisp=
 160
 161 - Copy =*.el= files to =emacs/lisp/org=, except =org-loaddefs.el=!
 162
 163 - You should create =org-version.el= in =emacs/lisp/org=.  The file is
 164   created when you =make= Org.
 165
 166 **** TODO =org-mode/testing=
 167
 168 *** Update  =emacs/etc/NEWS=
 169 Whenever a new (major) version of Org is synchronized to the Emacs
 170 repository, it should be mentioned in the NEWS file.
 171 * Updating the list of hooks/commands/options on Worg
 172
 173 Load the =mk/eldo.el= file then =M-x eldo-make-doc RET=.
 174
 175 This will produce an org file with the documentation.
 176
 177 Import this file into =worg/doc.org=, leaving the header untouched
 178 (except for the release number).
 179
 180 Then commit and push the change on the =worg.git= repository.
 181
 182 * Copyright assignments
 183
 184 The maintainer needs to keep track of copyright assignments.  Even
 185 better, find a volunteer to do this.
 186
 187 The assignment form is included in the repository as a file that you
 188 can send to contributors: =request-assign-future.txt=
 189
 190 The list of all contributors from who we have the papers is kept on
 191 Worg at https://orgmode.org/worg/org-contribute.html, so that
 192 committers can check if a patch can go into the core.
 193
 194 The assignment process does not allways go smoothly, and it has
 195 happened several times that it gets stuck or forgotten at the FSF.
 196 The contact at the FSF for this is: mailto:copyright-clerk@fsf.org
 197
 198 Emails from the paper submitter have been ignored in the past, but an
 199 email from me (Carsten) as the maintainer of Org mode has usually
 200 fixed such cases within a few days.