111
edits
9.1 Release Checklist: Difference between revisions
add notes about pre-releases for 9.x
(→✅ make check: Add link to Discourse thread about test suite results) |
(add notes about pre-releases for 9.x) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Note|'''Timeline''' (tentative) | {{Note|'''Timeline''' (tentative) | ||
* 2023-11-22 🚀 Release Kick-off ⚽ (default branch merged to stable) | * 2023-11-22 🚀 Release Kick-off ⚽ (default branch merged to stable) | ||
* | * 2024-02-07 🛠️ 1st release candidate '''9.0.90''' on https://alpha.gnu.org/gnu/octave/ | ||
* | * 2024-03-14 🏁 Final Release 🎉 '''9.1.0''' on https://ftp.gnu.org/gnu/octave/}} | ||
:Please use <code><strike> </strike></code> to mark items below as done. | :Please use <code><strike> </strike></code> to mark items below as done. | ||
| Line 16: | Line 16: | ||
=== 📢 Update GUI translation files === | === 📢 Update GUI translation files === | ||
:Completion Date: | :Completion Date: 2023-12-22 | ||
* <strike> Call for updates that might change GUI strings. </strike> | * <strike> Call for updates that might change GUI strings. </strike> | ||
* String freeze date: 2023-12-03 | * String freeze date: 2023-12-03 | ||
| Line 22: | Line 22: | ||
* <strike> Create issue report on Savannah as a centralized location for uploading files. bug {{bug|64982}} </strike> | * <strike> Create issue report on Savannah as a centralized location for uploading files. bug {{bug|64982}} </strike> | ||
* <strike> Call for translations for GUI strings on maintainers@octave.org, CC-ing the translators (see [https://hg.savannah.gnu.org/hgweb/octave/file/tip/libgui/languages/translators list of translators]). [https://lists.gnu.org/archive/html/octave-maintainers/2023-11/msg00004.html message in mailing list archive] </strike> | * <strike> Call for translations for GUI strings on maintainers@octave.org, CC-ing the translators (see [https://hg.savannah.gnu.org/hgweb/octave/file/tip/libgui/languages/translators list of translators]). [https://lists.gnu.org/archive/html/octave-maintainers/2023-11/msg00004.html message in mailing list archive] </strike> | ||
* Collect and push all translated files. | * <strike> Collect and push all translated files. </strike> | ||
=== <strike> ⚙️ Update gnulib to latest version </strike> === | === <strike> ⚙️ Update gnulib to latest version </strike> === | ||
| Line 30: | Line 30: | ||
=== ⚖️ GPL License activities === | === ⚖️ GPL License activities === | ||
:Completion Date: | :Completion Date: | ||
* Update copyright statements for all source controlled files. | * <strike> Update copyright statements for all source controlled files. </strike> | ||
* Update dates in any other locations (launch message, | * Update dates in any other locations (launch message, <strike> CITATION </strike>, MXE files, etc.). | ||
* Add any new contributors to {{Path|doc/interpreter/contributors.in}} who wish to be mentioned (don't add them without permission). | * <strike> Add any new contributors to {{Path|doc/interpreter/contributors.in}} who wish to be mentioned (don't add them without permission). </strike> | ||
=== ✅ Style-check code base === | === ✅ Style-check code base === | ||
:Completion Date: 2023-12-12 | :Completion Date: 2023-12-12 | ||
: This will produce lots of whitespace changes, but no behavior changes. '''Must occur after patches have been added''', since whitespace changes can prevent patches from applying. | : <strike> This will produce lots of whitespace changes, but no behavior changes. '''Must occur after patches have been added''', since whitespace changes can prevent patches from applying. </strike> | ||
* <strike> [[Octave style guide|m-file style check]] </strike> | * <strike> [[Octave style guide|m-file style check]] </strike> | ||
* <strike> [[C++ style guide|C++ style check]] </strike> | * <strike> [[C++ style guide|C++ style check]] </strike> | ||
| Line 60: | Line 60: | ||
=== ✅ <code>make check</code> === | === ✅ <code>make check</code> === | ||
* Verify <code>make check</code> is passing on all [http://buildbot.octave.org:8010/#/waterfall buildbot combinations of OS and compilers] and [https://github.com/gnu-octave/octave/actions GitHub CI runners]. Also check [https://github.com/gnu-octave/octave-buildbot/actions test suite runs on "freshly brewed Octave for Windows"] (Kai's buildbots on octave.space). | * Verify <code>make check</code> is passing on all [http://buildbot.octave.org:8010/#/waterfall buildbot combinations of OS and compilers] and [https://github.com/gnu-octave/octave/actions GitHub CI runners]. Also check [https://github.com/gnu-octave/octave-buildbot/actions test suite runs on "freshly brewed Octave for Windows"] (Kai's buildbots on octave.space). | ||
* Compiling with <code>-fsanitize=undefined</code>, <code>--enable-address-sanitizer-flags</code> to check for memory leaks. Use other tools <code>cppcheck</code>, etc. | * <strike> Compiling with <code>-fsanitize=undefined</code>, <code>--enable-address-sanitizer-flags</code> to check for memory leaks. Use other tools <code>cppcheck</code>, etc. </strike> | ||
** Update PVS static analyzer results [[PVS static analyzer - 5.0 Release]]. | ** <strike> Update PVS static analyzer results [[PVS static analyzer - 5.0 Release]]. </strike> WON'T DO | ||
** Or use any static analyzer, such as Clang's `scan-build make all`. | ** <strike> Or use any static analyzer, such as Clang's `scan-build make all`. </strike> WON'T DO | ||
* Start discussion on Discourse about which failing tests that must be fixed and which can be declared '''WON'T FIX''': [https://octave.discourse.group/t/test-suite-results-of-octave-9/5077 Test suite results of Octave 9] | * Start discussion on Discourse about which failing tests that must be fixed and which can be declared '''WON'T FIX''': [https://octave.discourse.group/t/test-suite-results-of-octave-9/5077 Test suite results of Octave 9] | ||
| Line 92: | Line 92: | ||
:Completion Date: | :Completion Date: | ||
* Octave mailing-lists | * Octave mailing-lists | ||
* Octave web site (https:// | * <strike>Octave web site (https://github.com/gnu-octave/gnu-octave.github.io)</strike> | ||
** Steps documented in [https:// | ** <strike>Steps documented in [https://github.com/gnu-octave/gnu-octave.github.io/commit/b623a44ffebfc610402caa5318bc44f5e2c8a52d this changeset].</strike> | ||
** Upload documentation (manual HTML + PDF {{Path|octave.org/doc}} and version in {{Path|octave.org/.htaccess}}, Doxygen {{Path|octave.org/doxygen}}) | ** <strike>Upload documentation (manual HTML + PDF {{Path|octave.org/doc}} and version in {{Path|octave.org/.htaccess}}, Doxygen {{Path|octave.org/doxygen}})</strike> | ||
* This wiki | * <strike>This wiki</strike> | ||
** [[Template:Release]] = {{Release}} | ** [[Template:Release]] = {{Release}} | ||
** [[Template:Release Date]] = {{Release Date}} | ** [[Template:Release Date]] = {{Release Date}} | ||
| Line 104: | Line 104: | ||
* <strike> Remove all deprecated functions (either tagged with <code>OCTAVE_DEPRECATED</code> in C++ or in the directory <code>scripts/deprecated</code> for m-files) scheduled for deletion on default branch. Check file <code>etc/NEWS.VERSION-2.md</code> for list of features that have been deprecated. | * <strike> Remove all deprecated functions (either tagged with <code>OCTAVE_DEPRECATED</code> in C++ or in the directory <code>scripts/deprecated</code> for m-files) scheduled for deletion on default branch. Check file <code>etc/NEWS.VERSION-2.md</code> for list of features that have been deprecated. | ||
* Create new <code>etc/NEWS.VERSION+1.md</code> file by copying <code>etc/NEWS.VERSION.md</code> and then removing text so that it is a template file with headings only. </strike> | * Create new <code>etc/NEWS.VERSION+1.md</code> file by copying <code>etc/NEWS.VERSION.md</code> and then removing text so that it is a template file with headings only. </strike> | ||
* Note: prereleases are not typically done for 9.x releases (only for the initial 9.1). | |||
** <strike>exceptionally, 9.2 had a pre-release b/c of Qt 5 to 6.</strike> | |||
== ℹ️ Versioning hints == | == ℹ️ Versioning hints == | ||