Difference between revisions of "6.3 Release Checklist"

From Octave
Jump to navigation Jump to search
m (Mark as "Won't Do")
 
(10 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
* 2021-05-11 Begin 6.3 Release Process
 
* 2021-05-11 Begin 6.3 Release Process
 
* 2021-05-18 First Release candidate '''6.2.9''' on https://alpha.gnu.org/gnu/octave/
 
* 2021-05-18 First Release candidate '''6.2.9''' on https://alpha.gnu.org/gnu/octave/
* 2020-05-25 Final Release '''6.3.0''' on https://ftp.gnu.org/gnu/octave/}}
+
* 2021-05-25 Final Release '''6.3.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 9: Line 9:
 
== Kick-off ==
 
== Kick-off ==
  
<strike> === Update gnulib to latest version ===
+
=== <strike> Updates for gnulib </strike> ===
  
: Should we make this change for the minor releases?  Ugh, NO; Only if absolutely necessary as this could cause significant changes in behavior.
+
<strike>For bug-fixing releases, changes to gnulib should only be done to fix known serious problems.  There were none for 6.3.</strike>
</strike>
 
  
 
=== Bugs that should be fixed before the release ===
 
=== Bugs that should be fixed before the release ===
Line 22: Line 21:
 
The following is all we should need to do for a minor release.
 
The following is all we should need to do for a minor release.
  
* Grammar check documentation.
+
* <strike> Grammar check documentation. </strike>
* Spell check documentation.
+
* <strike> Spell check documentation. </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>For minor release, review Mercurial logs for any bugs fixed on stable and publish in {{Path|NEWS}} file</strike>
 +
* <strike>Update installer {{Path|README.html}} file in MXE Octave.</strike>
  
<strike> === Call for translations ===
+
=== <strike> Translations </strike> ===
  
Is this job normally done for minor releases? NO, not normally done<p>
+
<strike>We don't normally update translation files for bug-fixing releases.</strike>
It not, we can remove this section? YES, I used strikethrough to indicate we don't need to do anything while leaving these comments in place
 
 
 
* Update language translation files (*.ts). (link here when available)
 
* Create issue report on Savannah as a centralized location for uploading files. (link here when available)
 
* Call for translations for GUI strings on discourse. (link here when available)
 
* Collect and push all translated files
 
</strike>
 
  
 
=== <code>make check</code> ===
 
=== <code>make check</code> ===
Line 45: Line 38:
 
=== Create new release candidate ===
 
=== Create new release candidate ===
  
* Ensure correct [[#Versioning hints|version information]].
+
* <strike>Ensure correct [[#Versioning hints|version information]].</strike>
* Create hg tag in repository with release candidate version number.
+
* <strike>Create hg tag in repository with release candidate version number.</strike>
 
* Verify <code>make distcheck</code> passes.
 
* Verify <code>make distcheck</code> passes.
* Verify <code>make dist</code> works.
+
* <strike>Verify <code>make dist</code> works.</strike>
* Create [[Windows Installer]].
+
* <strike>Create [[Windows Installer]].</strike>
* Upload release candidates.
+
* <strike>Upload release candidates.</strike>
* Add release candidate version to Savannah bug tracker.
+
* <strike>Add release candidate version to Savannah bug tracker.</strike>
* Announce release candidate to discourse.
+
* <strike>Announce release candidate to discourse.</strike>
  
 
== Final Release ==
 
== Final Release ==

Latest revision as of 13:04, 6 June 2021

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

Kick-off[edit]

Updates for gnulib [edit]

For bug-fixing releases, changes to gnulib should only be done to fix known serious problems. There were none for 6.3.

Bugs that should be fixed before the release[edit]

https://octave.space/savannah/?Action=get&Format=HTMLCSS&ItemID=56952,57557,59735,60209,59729,60174,60531,60471,60470

Review documentation[edit]

The following is all we should need to do for a minor release.

  • Grammar check documentation.
  • Spell check documentation.
  • Verify all formats (Info, HTML, PDF) build correctly.
  • For minor release, review Mercurial logs for any bugs fixed on stable and publish in NEWS file
  • Update installer README.html file in MXE Octave.

Translations [edit]

We don't normally update translation files for bug-fixing releases.

make check[edit]

  • Verify make check is passing on all buildbot combinations of OS and compilers.
  • Compiling with -fsanitize=undefined, --enable-address-sanitizer-flags to check for memory leaks. Use other tools cppcheck, etc.

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.
  • Add release candidate version to Savannah bug tracker.
  • Announce release candidate to discourse.

Final Release[edit]

Update version information[edit]

  • 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]

Post-Release[edit]

  • Update version info in configure.ac on stable branch and merge with default version information.

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