diff options
Diffstat (limited to 'admin/release-process')
| -rw-r--r-- | admin/release-process | 61 |
1 files changed, 32 insertions, 29 deletions
diff --git a/admin/release-process b/admin/release-process index 2668ea3b445..28f2307846d 100644 --- a/admin/release-process +++ b/admin/release-process | |||
| @@ -7,7 +7,7 @@ Each release cycle will be split into two periods. | |||
| 7 | ** Phase one: development | 7 | ** Phase one: development |
| 8 | 8 | ||
| 9 | The first phase of the release schedule is the "heads-down" working | 9 | The first phase of the release schedule is the "heads-down" working |
| 10 | period for new features, on the 'master' branch and several feature | 10 | period for new features, on the 'master' branch and any needed feature |
| 11 | branches. | 11 | branches. |
| 12 | 12 | ||
| 13 | ** Phase two: fixing and stabilizing the release branch | 13 | ** Phase two: fixing and stabilizing the release branch |
| @@ -29,47 +29,60 @@ command to do that, then commit the changes it made and push to | |||
| 29 | 'master'. For major releases, also update the value of | 29 | 'master'. For major releases, also update the value of |
| 30 | 'customize-changed-options-previous-release'. | 30 | 'customize-changed-options-previous-release'. |
| 31 | 31 | ||
| 32 | The 2 main manuals, the User Manual and the Emacs Lisp Manual, need to | 32 | Each chapter of the two main manuals, the User Manual and the Emacs |
| 33 | be proofread, preferably by at least 2 different persons, and any | 33 | Lisp Manual, should be proofread, preferably by at least two people. |
| 34 | uncovered problems fixed. This is a lot of work, so it is advisable | 34 | This job is so big that it should be considered a collective |
| 35 | to divide the job between several people (see the checklist near the | 35 | responsibility, not fobbed off on just a few people. After each |
| 36 | end of this file). | 36 | chapter is checked, mark off the name(s) of those who checked it in |
| 37 | the checklist near the end of this file. | ||
| 37 | 38 | ||
| 38 | In parallel to this phase, 'master' can receive new features, to be | 39 | In parallel to this phase, 'master' can receive new features, to be |
| 39 | released in the next release cycle. From time to time, the master | 40 | released in the next release cycle. From time to time, the master |
| 40 | branches merges bugfix commits from the "emacs-NN" branch. | 41 | branches merges bugfix commits from the "emacs-NN" branch. |
| 42 | See admin/gitmerge.el. | ||
| 41 | 43 | ||
| 42 | * RELEASE-CRITICAL BUGS | 44 | * RELEASE-CRITICAL BUGS |
| 43 | 45 | ||
| 44 | Emacs uses the "blocking bug(s)" feature of Debbugs for bugs need to | 46 | Emacs uses the "blocking" feature of Debbugs for bugs that need to be |
| 45 | be addressed in the next release. | 47 | addressed in the next release. |
| 46 | 48 | ||
| 47 | Currently, bug#19759 is the tracking bug for release of 25.1 and | 49 | Currently, bug#19759 is the tracking bug for release of 25.1 and |
| 48 | bug#21966 is the tracking bug for release of 25.2. Say bug#123 needs | 50 | bug#21966 is the tracking bug for release of 25.2. Say bug#123 needs |
| 51 | bug#21966 is the tracking bug for the next release. Say bug#123 needs | ||
| 49 | to be fixed for Emacs 25.1. Send a message to control@debbugs.gnu.org | 52 | to be fixed for Emacs 25.1. Send a message to control@debbugs.gnu.org |
| 50 | that says: | 53 | that says: |
| 51 | 54 | ||
| 52 | block 19759 by 123 | 55 | block 19759 by 123 |
| 53 | 56 | ||
| 54 | Change "block" to "unblock" to unblock the bug. | 57 | Change "block" to "unblock" to remove a bug from the list. Closed |
| 58 | bugs are not listed as blockers, so you do not need to explicitly | ||
| 59 | unblock one that has been closed. You may need to force an update of | ||
| 60 | the tracking bug with ctrl-f5/shift-reload to see the latest version. | ||
| 61 | |||
| 55 | 62 | ||
| 56 | * TO BE DONE SHORTLY BEFORE RELEASE | 63 | * TO BE DONE SHORTLY BEFORE RELEASE |
| 57 | 64 | ||
| 58 | ** Make sure the Copyright date reflects the current year in the source | 65 | See 'admin/make-tarball.txt' for the details of making a release or pretest. |
| 59 | files. See 'admin/notes/years' for information about maintaining | 66 | |
| 60 | copyright years for GNU Emacs. | 67 | ** Make sure the Copyright date reflects the current year in all source files. |
| 68 | (This should be done each January anyway, regardless of releases.) | ||
| 69 | See admin/update-copyright and admin.el's set-copyright. | ||
| 70 | For more details, see 'admin/notes/years'. | ||
| 61 | 71 | ||
| 62 | ** Make sure the necessary sources and scripts for any generated files | 72 | ** Make sure the necessary sources and scripts for any generated files |
| 63 | are included in the source tarball. (They don't need to be installed, | 73 | are included in the source tarball. (They don't need to be installed, |
| 64 | so e.g. admin/ is fine.) | 74 | so e.g. admin/ is fine.) This is important for legal compliance. |
| 65 | |||
| 66 | ** Regenerate AUTHORS by using admin/authors.el | ||
| 67 | (The instructions are at the beginning of that file.) | ||
| 68 | 75 | ||
| 69 | ** Remove temporary +++/--- lines in NEWS. | 76 | ** Remove temporary +++/--- lines in NEWS. |
| 70 | But first make sure there are no unmarked entries, and update the | 77 | But first make sure there are no unmarked entries, and update the |
| 71 | documentation (or decide no updates are necessary) for those that | 78 | documentation (or decide no updates are necessary) for those that aren't. |
| 72 | aren't. | 79 | |
| 80 | ** Try to reorder NEWS: most important things first, related items together. | ||
| 81 | |||
| 82 | ** For a major release, add a "New in Emacs XX" section to faq.texi. | ||
| 83 | |||
| 84 | ** cusver-check from admin.el can help find new defcustoms missing | ||
| 85 | :version tags. | ||
| 73 | 86 | ||
| 74 | ** Manuals | 87 | ** Manuals |
| 75 | Check for node names using problematic characters: | 88 | Check for node names using problematic characters: |
| @@ -85,8 +98,7 @@ For major releases, rewrite the "Antinews" appendix of the User Manual | |||
| 85 | previous version. The way to do that is read NEWS, pick up the more | 98 | previous version. The way to do that is read NEWS, pick up the more |
| 86 | significant changes and new features in the upcoming release, then | 99 | significant changes and new features in the upcoming release, then |
| 87 | describe the "benefits" from losing those features. Be funny, use | 100 | describe the "benefits" from losing those features. Be funny, use |
| 88 | humor. The text written for the previous major release can serve as | 101 | humor. The text written for the previous releases can serve as an example. |
| 89 | good example. | ||
| 90 | 102 | ||
| 91 | Check cross-references between the manuals (e.g. from emacs to elisp) | 103 | Check cross-references between the manuals (e.g. from emacs to elisp) |
| 92 | are correct. You can use something like the following in the info | 104 | are correct. You can use something like the following in the info |
| @@ -147,10 +159,6 @@ size that the GNU Press are going to use when they print the manuals. | |||
| 147 | I think this is different to what you get if you just use e.g. 'make | 159 | I think this is different to what you get if you just use e.g. 'make |
| 148 | emacs.pdf' (e.g., enable "smallbook"). | 160 | emacs.pdf' (e.g., enable "smallbook"). |
| 149 | 161 | ||
| 150 | ** Try to reorder NEWS: most important things first, related items together. | ||
| 151 | |||
| 152 | ** For a major release, add a "New in Emacs XX" section to faq.texi. | ||
| 153 | |||
| 154 | ** Check the keybindings in the refcards are correct, and add any new ones. | 162 | ** Check the keybindings in the refcards are correct, and add any new ones. |
| 155 | What paper size are the English versions supposed to be on? | 163 | What paper size are the English versions supposed to be on? |
| 156 | On Debian testing, the packages texlive-lang-czechslovak and | 164 | On Debian testing, the packages texlive-lang-czechslovak and |
| @@ -172,11 +180,6 @@ pt-br Rodrigo Real | |||
| 172 | ru Alex Ott | 180 | ru Alex Ott |
| 173 | sk Miroslav Vaško | 181 | sk Miroslav Vaško |
| 174 | 182 | ||
| 175 | ** cusver-check from admin.el can help find new defcustoms missing | ||
| 176 | :version tags. | ||
| 177 | |||
| 178 | ** Add a line to etc/HISTORY for the release version number and date. | ||
| 179 | |||
| 180 | * BUGS | 183 | * BUGS |
| 181 | 184 | ||
| 182 | ** Check for modes which bind M-s that conflicts with a new global binding M-s | 185 | ** Check for modes which bind M-s that conflicts with a new global binding M-s |