annotate etc/RELEASE_CHECKLIST.md @ 31591:d3ddf7be0235 stable

maint: Update RELEASE_CHECKLIST.md. * RELEASE_CHECKLIST.md: Remove task to update EDITION number in octave.texi (now automated). Add instructions for running clang static analyzer.
author Rik <rik@octave.org>
date Tue, 29 Nov 2022 13:15:07 -0800
parents 59ca7d2805f2
children bc24b226891a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
1 # `VERSION`.1 Release Checklist #
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
2
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
3 **Timeline** (tentative)
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
4
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
5 * YYYY-MM-DD 🚀 Release Kick-off ⚽ (default branch merged to stable)
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
6 * YYYY-MM-DD 🛠️ 1st release candidate **`VERSION`.0.90** on
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
7 <https://alpha.gnu.org/gnu/octave/>
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
8 * YYYY-MM-DD 🏁 Final Release 🎉 **`VERSION`.1.0** on
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
9 <https://ftp.gnu.org/gnu/octave/>
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
10
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
11 Please use `<strike> </strike>` to mark items below as done.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
12
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
13 ## 🚀 Kick-off ⚽ ##
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
14
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
15 ------------------------------------------------------------
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
16
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
17 ### ⚙️ Update stable and default branch to new version numbers ###
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
18
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
19 Completion Date:
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
20
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
21 * Merge default onto stable to become the current stable release (see
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
22 instructions in `etc/HACKING.md`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
23 * Bump version numbers in `configure.ac` on stable branch (see
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
24 `etc/HACKING.md`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
25 * Bump version numbers in `configure.ac` on default branch (see
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
26 `etc/HACKING.md`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
27
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
28 ### ⚙️ Update gnulib to latest version ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
29
31549
ed7b17c7ddf3 maint: Strip trailing spaces and add missing EOL to all files.
Rik <rik@octave.org>
parents: 31510
diff changeset
30 Completion Date:
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
31
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
32 **Must occur first** as it could resolve existing, or create new, bug reports.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
33 You should run `./bootstrap` in the source tree after updating to the new
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
34 gnulib version.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
35
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
36 ### 📢 Call for bug reports ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
37
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
38 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
39
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
40 * Put out a general call for reports on [Octave Discourse](https://octave.discourse.group/) for all outstanding unreported known bugs.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
41 * Create Savannah tag `VERSION.0.90` on bug tracker for 1st release candidate.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
42 * Mark items that should be fixed for the release with this tag.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
43 * Bug overview at <https://octave.space/savannah/>.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
44
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
45 ### 📢 Update GUI translation files ###
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
46
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
47 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
48
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
49 * Call for updates ([Octave Discourse](https://octave.discourse.group/)) that
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
50 might change GUI strings.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
51 * String freeze date:
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
52 * Update language translation files (`*.ts`). See instructions in
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
53 `libgui/languages/build_ts/README.md`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
54 * Create bug report on Savannah as a centralized location for uploading files
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
55 and tracking status of translations.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
56 * Call for translations of GUI strings on [Octave Discourse Maintainers](https://octave.discourse.group/c/maintainers/7), CC-ing the translators (see [list of translators](https://hg.savannah.gnu.org/hgweb/octave/file/tip/libgui/languages/translators)).
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
57 * Collect translation files on Savannah bug report and push to Mercurial.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
58
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
59 ### ⚖️ GPL License activities ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
60
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
61 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
62
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
63 * Update copyright statements for all source controlled files.
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
64 * Update dates in any other locations (launch message, citation, MXE files,
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
65 etc.).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
66 * Add any new contributors to `doc/interpreter/contributors.in` who wish to be
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
67 mentioned (don't add them without permission).
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
68
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
69 ### ✅ Style-check code base ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
70
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
71 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
72
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
73 This will produce lots of whitespace changes, but no behavior changes. **Must
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
74 occur after patches have been added**, since whitespace changes can prevent
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
75 patches from applying.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
76
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
77 * [m-file style check](https://wiki.octave.org/Octave_style_guide)
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
78 * [C++ style check](https://wiki.octave.org/C%2B%2B_style_guide)
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
79
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
80 ### 📖 Review documentation ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
81
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
82 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
83
31510
127ffe17714c Document more clearly how to spellcheck Octave documentation before a release.
Rik <rik@octave.org>
parents: 31507
diff changeset
84 * Grammar check documentation (See `doc/interpreter/doccheck/README`).
127ffe17714c Document more clearly how to spellcheck Octave documentation before a release.
Rik <rik@octave.org>
parents: 31507
diff changeset
85 * Spell check documentation (`make spellcheck`).
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
86 * Verify no functions missing from manual
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
87 (`make doc/interpreter/undocumented_list`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
88 * Verify deprecated functions removed from manual (`*.txi`) and from "see also"
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
89 links.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
90 * Verify all formats (Info, HTML, PDF) build correctly.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
91 * Review `etc/NEWS.VERSION.md` for any features which should be announced.
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
92 * Review `__unimplemented__.m` for the latest changes to
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
93 [Octave Forge](https://wiki.octave.org/Octave_Forge) packages and new Matlab
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
94 functions.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
95 * Update `installer-files/README.html` in MXE Octave with version highlights.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
96
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
97 ## 🔃 Repeat until all bugs are resolved ##
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
98
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
99 ------------------------------------------------------------
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
100
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
101 Completion Date of first iteration:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
102
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
103 ### ⚠️ Current state at Savannah ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
104
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
105 Bug overview at <https://octave.space/savannah/>.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
106
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
107 ### ✅ `make check` ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
108
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
109 * Verify `make check` is passing on all [buildbot combinations of OS and compilers](http://buildbot.octave.org:8010/#/waterfall) and [GitHub CI runners](https://github.com/gnu-octave/octave/actions). Also check [test suite runs on "freshly brewed Octave for Windows"](https://github.com/gnu-octave/octave-buildbot/actions) (Kai's buildbots on octave.space).
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
110 * Use software tools to check quality of Octave code.
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
111 * Check for memory leaks by configuring with
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
112 `--enable-address-sanitizer-flags` and compiling with
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
113 `-fsanitize=undefined`, `-fno-omit-frame-pointer` in `CFLAGS`, `CXXFLAGS`,
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
114 and `LDFLAGS`.
31591
d3ddf7be0235 maint: Update RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31567
diff changeset
115 * Update static code analysis results.
d3ddf7be0235 maint: Update RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31567
diff changeset
116 * For `clang`, do `scan-build make -j<N> all` and then `scan-view`.
d3ddf7be0235 maint: Update RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31567
diff changeset
117 * See [PVS static analyzer - 5.0 Release](https://wiki.octave.org/PVS_static_analyzer_-_5.0_Release).
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
118 * Use other tools such as `cppcheck`, etc.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
119 * Start discussion on [Octave Discourse Maintainers](https://octave.discourse.group/c/maintainers/8) about which failing tests that must be fixed and which can be declared **WON'T FIX**.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
120
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
121 ### 🛠️ Create new release candidate ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
122
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
123 * Ensure correct version information (see "Release Numbering" in
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
124 `/etc/HACKING.md`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
125 * Create `hg tag` in repository with release candidate version number
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
126 (`rc-MAJOR-MINOR-PATCH`).
31591
d3ddf7be0235 maint: Update RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31567
diff changeset
127 * Verify `make dist` works.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
128 * Verify `make distcheck` passes.
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
129 * Create [Windows Installer](https://wiki.octave.org/Windows_Installer).
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
130 * Upload release candidates to <https://alpha.gnu.org/gnu/octave/>.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
131 * Check [Windows Installer](https://wiki.octave.org/Windows_Installer)
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
132 (executable and zip formats) against false positive detection at
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
133 [virustotal.com](https://virustotal.com/).
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
134 * Add release candidate version to Savannah bug tracker.
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
135 * Announce release candidate to
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
136 [Octave Discourse](https://octave.discourse.group/).
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
137
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
138 ## 🏁 Final Release 🎉 ##
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
139
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
140 ------------------------------------------------------------
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
141
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
142 ### 📃 Update version information ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
143
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
144 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
145
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
146 * Ensure correct version information in `configure.ac` (see "Release Numbering"
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
147 in `/etc/HACKING.md`)
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
148 * Set `OCTAVE_RELEASE_DATE` to the current date.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
149 * Set the year in `OCTAVE_COPYRIGHT` to the current year.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
150 * Create `hg tag` in repository with release candidate version number
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
151 (`release-VERSION-1-0`).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
152 * Update `etc/NEWS.VERSION.md` (final release date in Summary header).
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
153 * Update `CITATION` (version, year, URL).
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
154 * Update `etc/icons/org.octave.Octave.appdata.xml` (version number and release
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
155 date).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
156 * Upload all tarballs to <https://ftp.gnu.org/gnu/octave/>.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
157 * Update web site files: `NEWS-VERSION.html`, `index.in`, `news.in`, and
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
158 `download.in`.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
159 * Update <https://wiki.octave.org/Release_History> page.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
160 * Update Savannah bug tracker version info to have new release number.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
161 * Update Savannah bug tracker: **OPEN** bugs marked as **WON'T FIX** should be
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
162 marked as **CONFIRMED** (or more appropriate) for the final release.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
163 * Hide release candidate versions in Savannah.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
164
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
165 ### 📢 Announce final release ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
166
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
167 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
168
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
169 * Octave mailing-lists (yes, still) <help@octave.org> and <info-gnu@gnu.org>.
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
170 * Octave web site (<https://hg.octave.org/web-octave>)
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
171 * Steps documented in this
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
172 [changeset](https://hg.octave.org/web-octave/rev/fe59d0118a2b).
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
173 * Upload documentation (manual HTML + PDF `octave.org/doc` and version in
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
174 `octave.org/.htaccess`, Doxygen `octave.org/doxygen`)
31507
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
175 * This wiki
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
176 * Template:Release = 7.3.0
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
177 * Template:Release Date = November 2, 2022
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
178 * Template:Release Year = 2022
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
179
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
180 ### ☑️ Post-Release ###
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
181
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
182 Completion Date:
71f9f7210b7c RELEASE_CHECKLIST.md: New file with actions to perform for Octave release.
Rik <rik@octave.org>
parents:
diff changeset
183
31567
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
184 * Remove all deprecated functions (either tagged with `OCTAVE_DEPRECATED` in
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
185 C++ or in the directory `scripts/deprecated` for m-files) scheduled for
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
186 deletion on default branch. Check file `etc/NEWS.VERSION-2.md` for list of
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
187 features that have been deprecated.
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
188 * Create new `etc/NEWS.VERSION+1.md` file by copying `etc/NEWS.VERSION.md` and
59ca7d2805f2 doc: Update HACKING.md and RELEASE_CHECKLIST.md.
Rik <rik@octave.org>
parents: 31549
diff changeset
189 then removing text so that it is a template file with headings only.