Editing 8.1 Release Checklist

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{Note|'''Timeline''' (tentative)
{{Note|'''Timeline''' (tentative)
* 2022-11-15 πŸš€ Release Kick-off ⚽  (default branch merged to stable)
* 2022-11-15 πŸš€ Release Kick-off ⚽  (default branch merged to stable)
* 2023-01-23 πŸ› οΈ 1st release candidate '''8.0.90''' on https://alpha.gnu.org/gnu/octave/
* 2022-xx-xx πŸ› οΈ 1st release candidate '''8.0.90''' on https://alpha.gnu.org/gnu/octave/
* 2023-03-07 🏁 Final Release πŸŽ‰ '''8.1.0''' on https://ftp.gnu.org/gnu/octave/}}
* 2022-xx-xx 🏁 Final Release πŸŽ‰ '''8.1.0''' on https://ftp.gnu.org/gnu/octave/}}


:Please use <code>&lt;strike&gt; &lt;/strike&gt;</code> to mark items below as done.
:Please use <code>&lt;strike&gt; &lt;/strike&gt;</code> to mark items below as done.
Line 15: Line 15:
* Bug overview at https://octave.space/savannah/ .
* Bug overview at https://octave.space/savannah/ .


=== <strike> πŸ“’ Update GUI translation files </strike> ===
=== πŸ“’ Call for translations ===
:Completion Date: 2022-11-28
:Completion Date:
* <strike> WON'T DO: Call for updates that might change GUI strings. </strike>
* Call for updates that might change GUI strings.
* String freeze date: 2022-11-25
* String freeze date: Β 
* <strike> Update language translation files (*.ts). </strike> 2022-11-24
* Update language translation files (*.ts).
* <strike> Create issue report on Savannah as a centralized location for uploading files. </strike> bug {{bug|63404}}
* Create issue report on Savannah as a centralized location for uploading files.
* <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]). </strike> [https://lists.gnu.org/archive/html/octave-maintainers/2022-11/msg00004.html message in mailing list archive]
* 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]).
* <strike> Collect and push all translated files. </strike>
* Collect and push all translated files.


=== <strike> βš™οΈ Update gnulib to latest version </strike> ===
=== βš™οΈ Update gnulib to latest version ===
:Completion Date: 2022-11-12
:Completion Date: Β 
:<strike> Must occur first as it could resolve existing, or create new, bug reports. You should run <code>./bootstrap</code> in the source tree after updating to the new gnulib version. </strike>
:Must occur first as it could resolve existing, or create new, bug reports. You should run <code>./bootstrap</code> in the source tree after updating to the new gnulib version.


=== <strike> βš–οΈ GPL License activities </strike> ===
=== βš–οΈ GPL License activities ===
:Completion Date: 2022-12-13
:Completion Date:
* <strike> 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, citation, MXE files, etc.). </strike>
* Update dates in any other locations (launch message, citation, MXE files, etc.).
* <strike> 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 </strike> ===
=== βœ… Style-check code base ===
:Completion Date: 2022-12-6
:Completion Date: Β 
:<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>
: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> [[Octave style guide|m-file style check]] </strike>
* [[Octave style guide|m-file style check]]
* <strike> [[C++ style guide|C++ style check]] </strike>
* [[C++ style guide|C++ style check]]


=== πŸ“– Review documentation ===
=== πŸ“– Review documentation ===
:Completion Date: 2022-12-14
:Completion Date:
* <strike> Grammar check documentation. </strike>
* Grammar check documentation.
* <strike> Spell check documentation. </strike>
* Spell check documentation.
* <strike> Verify no functions missing from manual. </strike>
* Verify no functions missing from manual.
* <strike> Verify deprecated functions removed from "see also" links. </strike>
* Verify deprecated functions removed from "see also" links.
* <strike> Verify all formats (Info, HTML, PDF) build correctly. </strike>
* Verify all formats (Info, HTML, PDF) build correctly.
* <strike> Review {{Path|NEWS}} for any features which should be announced. </strike>
* Review {{Path|NEWS}} for any features which should be announced.
* <strike> Review {{Path|__unimplemented__.m}} for the latest changes to [[Octave Forge]] packages and new Matlab functions. </strike>
* Review {{Path|__unimplemented__.m}} for the latest changes to [[Octave Forge]] packages and new Matlab functions.
* <strike> Update major version number in "@subtitle Edition XXX" in {{Path|octave.texi}}. </strike>
* Update major version number in "@subtitle Edition XXX" in {{Path|octave.texi}}.
* <strike> Update {{Path|[https://hg.octave.org/mxe-octave/file/tip/installer-files/README.html installer-files/README.html]}} in MXE Octave with version highlights. </strike>
* Update {{Path|[https://hg.octave.org/mxe-octave/file/tip/installer-files/README.html installer-files/README.html]}} in MXE Octave with version highlights.


== πŸ”ƒ Repeat until all bugs are resolved ==
== πŸ”ƒ Repeat until all bugs are resolved ==
Line 61: Line 61:
=== βœ… <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).
* <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>
* Compiling with <code>-fsanitize=undefined</code>, <code>--enable-address-sanitizer-flags</code> to check for memory leaks. Use other tools <code>cppcheck</code>, etc.
** '''WON'T DO''' <strike> Update PVS static analyzer results [[PVS static analyzer - 5.0 Release]]. </strike>
** Update PVS static analyzer results [[PVS static analyzer - 5.0 Release]].
* Start discussion on maintainers@octave.org about which failing tests that must be fixed and which can be declared '''WON'T FIX'''.
* Start discussion on maintainers@octave.org about which failing tests that must be fixed and which can be declared '''WON'T FIX'''.


Line 68: Line 68:
* Ensure correct [[#Versioning hints|version information]].
* Ensure correct [[#Versioning hints|version information]].
* Create hg tag in repository with release candidate version number.
* Create hg tag in repository with release candidate version number.
* <strike> Verify <code>make distcheck</code> passes. </strike>
* Verify <code>make distcheck</code> passes.
* <strike> Verify <code>make dist</code> works. </strike>
* Verify <code>make dist</code> works.
* Create [[Windows Installer]].
* Create [[Windows Installer]].
* Upload release candidates.
* Upload release candidates.
Line 102: Line 102:
== β˜‘οΈ Post-Release ==
== β˜‘οΈ Post-Release ==
:Completion Date:
:Completion Date:
* <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>
* Merge default onto stable to become the current stable release.
* <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>
* Ensure correct [[#Versioning hints|version information]].
* Remove all deprecated functions (either <code>OCTAVE_DEPRECATED</code> in C++ or scripts/deprecated for m-files) scheduled for deletion in "default" branch.
* Move {{Path|NEWS}} file to backup in {{Path|etc/NEWS.X}}.
* Create new {{Path|NEWS}} file.


== ℹ️ Versioning hints ==
== ℹ️ Versioning hints ==
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)