8.1 Release Checklist: Difference between revisions

From Octave
Jump to navigation Jump to search
m (Mark items done)
(Update timeline.)
 
(23 intermediate revisions by 2 users not shown)
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)
* 2022-xx-xx 🛠ī¸ 1st release candidate '''8.0.90''' on https://alpha.gnu.org/gnu/octave/
* 2023-01-23 🛠ī¸ 1st release candidate '''8.0.90''' on https://alpha.gnu.org/gnu/octave/
* 2022-xx-xx 🏁 Final Release 🎉 '''8.1.0''' on https://ftp.gnu.org/gnu/octave/}}
* 2023-03-07 🏁 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/ .


=== đŸ“ĸ Call for translations ===
=== <strike> đŸ“ĸ Update GUI translation files </strike> ===
:Completion Date:
:Completion Date: 2022-11-28
* Call for updates that might change GUI strings.
* <strike> WON'T DO: Call for updates that might change GUI strings. </strike>
* String freeze date:  
* String freeze date: 2022-11-25
* Update language translation files (*.ts).
* <strike> Update language translation files (*.ts). </strike> 2022-11-24
* Create issue report on Savannah as a centralized location for uploading files.
* <strike> Create issue report on Savannah as a centralized location for uploading files. </strike> bug {{bug|63404}}
* 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> 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]
* 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> ===
:Completion Date: Nov. 12th, 2022
:Completion Date: 2022-11-12
:<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>
:<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 </strike> ===
:Completion Date:
:Completion Date: 2022-12-13
* 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 </strike> ===
:Completion Date:  
:Completion Date: 2022-12-6
: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]] </strike>


=== 📖 Review documentation ===
=== 📖 Review documentation ===
:Completion Date:
:Completion Date: 2022-12-14
* 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. </strike>


== 🔃 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).
* 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]].
** '''WON'T DO''' <strike> Update PVS static analyzer results [[PVS static analyzer - 5.0 Release]]. </strike>
* 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.
* 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. </strike>
* Create [[Windows Installer]].
* Create [[Windows Installer]].
* Upload release candidates.
* Upload release candidates.
Line 102: Line 102:
== ☑ī¸ Post-Release ==
== ☑ī¸ Post-Release ==
:Completion Date:
:Completion Date:
* Merge default onto stable to become the current stable release.
* <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>
* Ensure correct [[#Versioning hints|version information]].
* <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>
* 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 ==

Latest revision as of 13:07, 16 April 2023

Info icon.svg
Timeline (tentative)
Please use <strike> </strike> to mark items below as done.

🚀 Kick-off âšŊ[edit]

đŸ“ĸ Call for bug reports[edit]

Completion Date:
  • WON'T DO: Put out a general call for reports on Octave Discourse for all outstanding unreported known bugs.
  • Create Savannah tag 8.0.90 on bug tracker.
  • Mark items that should be fixed for the release with this tag.
  • Bug overview at https://octave.space/savannah/ .

đŸ“ĸ Update GUI translation files [edit]

Completion Date: 2022-11-28
  • WON'T DO: Call for updates that might change GUI strings.
  • String freeze date: 2022-11-25
  • Update language translation files (*.ts). 2022-11-24
  • Create issue report on Savannah as a centralized location for uploading files. bug #63404
  • Call for translations for GUI strings on maintainers@octave.org, CC-ing the translators (see list of translators). message in mailing list archive
  • Collect and push all translated files.

⚙ī¸ Update gnulib to latest version [edit]

Completion Date: 2022-11-12
Must occur first as it could resolve existing, or create new, bug reports. You should run ./bootstrap in the source tree after updating to the new gnulib version.

⚖ī¸ GPL License activities [edit]

Completion Date: 2022-12-13
  • Update copyright statements for all source controlled files.
  • Update dates in any other locations (launch message, citation, MXE files, etc.).
  • Add any new contributors to doc/interpreter/contributors.in who wish to be mentioned (don't add them without permission).

✅ Style-check code base [edit]

Completion Date: 2022-12-6
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.

📖 Review documentation[edit]

Completion Date: 2022-12-14
  • Grammar check documentation.
  • Spell check documentation.
  • Verify no functions missing from manual.
  • Verify deprecated functions removed from "see also" links.
  • Verify all formats (Info, HTML, PDF) build correctly.
  • Review NEWS for any features which should be announced.
  • Review __unimplemented__.m for the latest changes to Octave Forge packages and new Matlab functions.
  • Update major version number in "@subtitle Edition XXX" in octave.texi.
  • Update installer-files/README.html in MXE Octave with version highlights.

🔃 Repeat until all bugs are resolved[edit]

Completion Date first iteration:

⚠ī¸ Current state at Savannah[edit]

✅ make check[edit]

🛠ī¸ Create new release candidate[edit]

  • Ensure correct version information.
  • Create hg tag in repository with release candidate version number.
  • Verify make distcheck passes.
  • Verify make dist works.
  • Create Windows Installer.
  • Upload release candidates.
  • Check Windows Installer (executable and zip formats) against false positive detection at virustotal.com
  • Add release candidate version to Savannah bug tracker.
  • Announce release candidate to Octave Discourse.

🏁 Final Release 🎉[edit]

📃 Update version information[edit]

Completion Date:
  • Ensure correct version information.
  • Create hg tag in repository with release version number.
  • Update NEWS (final release date).
  • Update CITATION (version, year, URL).
  • Update org.octave.Octave.appdata.xml (version number and release date).
  • Update Savannah bug tracker version info.
  • Update Savannah bug tracker: OPEN bugs marked as WON'T FIX should be marked as CONFIRMED (or more appropriate) for the final release.
  • Remove release candidate versions from Savannah.

đŸ“ĸ Announce final release[edit]

Completion Date:

☑ī¸ Post-Release[edit]

Completion Date:
  • Remove all deprecated functions (either tagged with OCTAVE_DEPRECATED in C++ or in the directory scripts/deprecated for m-files) scheduled for deletion on default branch. Check file etc/NEWS.VERSION-2.md for list of features that have been deprecated.
  • Create new etc/NEWS.VERSION+1.md file by copying etc/NEWS.VERSION.md and then removing text so that it is a template file with headings only.

ℹī¸ Versioning hints[edit]

Info icon.svg
Read etc/HACKING.md carefully!!
  • Update configure.ac:
    • AC_INIT
    • OCTAVE_API_VERSION
    • OCTAVE_MAJOR/MINOR/PATCH_VERSION
    • OCTAVE_RELEASE_DATE
  • Update libtool versioning:
    • liboctave/module.mk %canon_reldir%_%canon_reldir%_current
    • libinterp/module.mk %canon_reldir%_liboctinterp_current
    • libgui/module.mk %canon_reldir%_liboctgui_current