ox: calculation separators don't produce row groups
[org-mode/org-tableheadings.git] / README_maintainer
1 # -*- mode:org -*-
3 #+TITLE: Org maintainer tasks
4 #+STARTUP: noindent
5 #+OPTIONS: ^:nil
7 This document describes the tasks the Org-mode maintainer has to do
8 and how they are performed.
10 * Git workflow
12 The git repository has two branches:
14 - master :: for current development.
16 - maint :: for bug fixes against latest major or minor release.
18 Bug fixes always go on =maint= then are merged on =master=.
20 New features always go on =master=.
22 * Releasing
24 ** Major release
26 The release number for main releases look like this: =9.1=
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.
32 A major release turns the current state of the master branch into a
33 release.
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.
39 ** Minor release
41 The release number for minor releases look like this: =9.1.7=
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.
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.
52 ** Tagging the release
54 When doing a major and a minor release, after all necessary merging is
55 done, tag the _maint_ branch for the release with:
57   git tag -a release_9.1.7 -m "Adding release tag"
59 and push tags with
61   git push --tags
63 We also encourage you to sign release tags like this:
65   git tag -s release_9.1.7 -m "Adding release tag"
67 ** Uploading the release files from the orgmode.org server
69 Log on the orgmode.org server as the emacs user and cd to
70 ~/git/org-mode
72 From there do
74   make release
75   make upload
77 to create the =.tar.gz= and =.zip= files, the documentation, and to upload
78 everything at the right place.
80 * Available Org's builds on the server
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=.
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.
89 =org-latest*= snapshots are built from the *master* branch.
91 * Synchronization Org and upstream Emacs
93 Below it is described how Org is kept in sync with the upstream Emacs.
95 ** Backporting changes from upstream Emacs
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.
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:
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
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.
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.
117 ** Updating the Org version in upstream Emacs
119 New releases of Org should be added to the [[https://git.savannah.gnu.org/cgit/emacs.git][Emacs repository]].
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
124 with the =maint= branch.  If the Emacs maintainers are planning a new
125 release of Emacs soon, it is possible that another branch should be
126 used.
128 If the new release of Org contains many changes, it may be useful to
129 use a separate branch before merging, e.g. =scratch/org-mode-merge=.
130 This branch can then be merged with the =master= branch, when everything
131 has been tested.
133 Please see [[http://git.savannah.gnu.org/cgit/emacs.git/tree/CONTRIBUTE][CONTRIBUTE]] in the Emacs repository for guidelines on
134 contributing to the Emacs repository.
136 *** Where to files go
138 The following list shows where files in Org repository are copied to
139 in the Emacs repository, folder by folder.
141 **** =org-mode/doc=
143 - =org.texi= :: Copy to =emacs/doc/misc=.  It may be necessary to replace,
144      ~@include org-version.inc~ with ~@set VERSION 9.0.9~ or similar.
146 - =orgcard.tex= :: Copy to =emacs/etc/refcards=.  Make sure that
147      ~\def\orgversionnumber~ and ~\def\versionyear~ are up to date.
149 **** =org-mode/etc=
151 - =styles/*= :: Copy to =emacs/etc/org=.
153 - =schema/*.rnc= :: Copy to =emacs/etc/schema=.
155 - =schema/schemas.xml= :: Any new entries in this file should be added
156      to =emacs/etc/schema/schemas.xml=.
158 - =ORG-NEWS= :: Copy to =emacs/etc=
160 **** =org-mode/lisp=
162 - Copy =*.el= files to =emacs/lisp/org=, except =org-loaddefs.el=!
164 - You should create =org-version.el= in =emacs/lisp/org=.  The file is
165   created when you =make= Org.
167 **** TODO =org-mode/testing=
169 *** Update  =emacs/etc/NEWS=
171 Whenever a new (major) version of Org is synchronized to the Emacs
172 repository, it should be mentioned in the NEWS file.
174 * Updating the list of hooks/commands/options on Worg
176 Load the =mk/eldo.el= file then =M-x eldo-make-doc RET=.
178 This will produce an org file with the documentation.
180 Import this file into =worg/doc.org=, leaving the header untouched
181 (except for the release number).
183 Then commit and push the change on the =worg.git= repository.
185 * Copyright assignments
187 The maintainer needs to keep track of copyright assignments.  Even
188 better, find a volunteer to do this.
190 The assignment form is included in the repository as a file that you
191 can send to contributors: =request-assign-future.txt=
193 The list of all contributors from who we have the papers is kept on
194 Worg at https://orgmode.org/worg/org-contribute.html, so that
195 committers can check if a patch can go into the core.
197 The assignment process does not allways go smoothly, and it has
198 happened several times that it gets stuck or forgotten at the FSF.
199 The contact at the FSF for this is: mailto:copyright-clerk@fsf.org
201 Emails from the paper submitter have been ignored in the past, but an
202 email from me (Carsten) as the maintainer of Org mode has usually
203 fixed such cases within a few days.