Difference between revisions of "Release Checklist"

From Octave
Jump to navigation Jump to search
(Start overhauling the template.)
 
(20 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
: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.
 
: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.
  
=== File bug reports ===
+
=== Call for bug reports ===
 
:Completion Date:
 
:Completion Date:
* Put out a general call for reports on maintainers@octave.org and help@octave.org mailing-list for all outstanding unreported known bugs.
+
* Put out a general call for reports on maintainers@octave.org and help@octave.org for all outstanding unreported known bugs.
  
 
=== Review submitted patches on Savannah ===
 
=== Review submitted patches on Savannah ===
Line 24: Line 24:
 
* Review bugs and update to correct category, such as "Patch submitted", correct title if necessary.
 
* Review bugs and update to correct category, such as "Patch submitted", correct title if necessary.
 
* Add "must-fix" items to [[6.1 Release Bug Fix List]].
 
* Add "must-fix" items to [[6.1 Release Bug Fix List]].
 +
 +
== One time tasks ==
  
 
=== GPL License activities ===
 
=== GPL License activities ===
Line 29: Line 31:
 
* Update copyright statements for all source controlled files.
 
* Update copyright statements for all source controlled files.
 
* Update dates in any other locations (launch message, citation, MXE files, etc.).
 
* Update dates in any other locations (launch message, citation, MXE files, etc.).
* Add any new contributors to {{Path|contributors.in}} who wish to be mentioned (don't add them without permission).
+
* Add any new contributors to {{Path|doc/interpreter/contributors.in}} who wish to be mentioned (don't add them without permission).
  
 
=== Style-check code base ===
 
=== Style-check code base ===
 
:Completion Date:
 
:Completion Date:
: 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
+
: 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.
 
* m-file style check
 
* m-file style check
 
* C++ style check
 
* C++ style check
  
 +
=== Review documentation ===
 +
:Completion Date:
 +
* 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 {{Path|NEWS}} for any features which should be announced.
 +
* Update major version number in "@subtitle Edition XXX" in {{Path|octave.texi}}.
 +
 +
=== Call for translations ===
 +
:Completion Date:
 +
* Update language translation files (*.ts).
 +
* Create issue report on Savannah as a centralized location for uploading files.
 +
* Call for translations for GUI strings on maintainers@octave.org.
  
 
== Repeat until all bugs are resolved ==
 
== Repeat until all bugs are resolved ==
 +
:Completion Date first iteration:
 +
 +
=== Merge submitted patches ===
 +
* Push translations provided by translators.
 +
* Push reviewed patches from Savannah.
 +
 +
=== <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].
 +
* Compiling with <code>-fsanitize=undefined</code>, <code>--enable-address-sanitizer-flags</code> to check for memory leaks. Use other tools <code>cppcheck</code>, etc.
 +
** 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'''.
 +
 +
=== Create new release candidate ===
 +
* Ensure correct [[#Versioning hints|version information]].
 +
* Create hg tag in repository with release candidate version number.
 +
* Verify <code>make distcheck</code> passes.
 +
* Verify <code>make dist</code> works.
 +
* Create [[Windows Installer]].
 +
* Upload release candidates.
 +
* Add release candidate version to Savannah bug tracker.
 +
* Announce release candidate to maintainers@octave.org, help@octave.org mailing-list, on web page.
 +
 +
== Final Release ==
 +
 +
=== Update version information ===
 +
:Completion Date:
 +
* Ensure correct [[#Versioning hints|version information]].
 +
* Create hg tag in repository with release version number.
 +
* Update {{Path|NEWS}} (final release date).
 +
* Update {{Path|CITATION}} (version, year, URL).
 +
* Update {{Path|org.octave.Octave.appdata.xml}} (version number and release date).
 +
* Update Savannah bug tracker version info.
 +
* Remove release candidate versions from Savannah.
  
=== Run lint checker on code base ===
+
=== Announce final release ===
 
:Completion Date:
 
:Completion Date:
* Compiling with <code>-fsanitize=undefined</code> and running <code>make check</code>, <code>cppcheck</code>, etc.
+
* Octave mailing-lists
** PVS static analyzer results [[PVS static analyzer - 5.0 Release]]
+
* Octave web site
 +
* This wiki
 +
 
 +
== Post-Release ==
 +
:Completion Date:
 +
* Merge default onto stable to become the current stable release.
 +
* 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 ==
 +
 
 +
{{Note|Read [https://hg.savannah.gnu.org/hgweb/octave/file/tip/etc/HACKING.md <code>etc/HACKING.md</code>] carefully!!}}
  
<!----------------------------------------------------------------------------->
+
* Update {{Path|configure.ac}}:
# Verify 'make check' is passing on all buildbot combinations of OS and compilers
+
** <code>AC_INIT</code>
#* Start discussion on octave-maintainers list about which failing tests must be fixed
+
** <code>OCTAVE_API_VERSION</code>
#* Identify and fix any tests determined critical in step above
+
** <code>OCTAVE_MAJOR/MINOR/PATCH_VERSION</code>
#: Completion Date:
+
** <code>OCTAVE_RELEASE_DATE</code>
<!----------------------------------------------------------------------------->
+
* Update libtool versioning:
# Compile and run Octave test suite with --enable-address-sanitizer-flags to check for memory leaks
+
** {{Path|liboctave/module.mk}} <code>%canon_reldir%_%canon_reldir%_current</code>
#: Completion Date:
+
** {{Path|libinterp/module.mk}} <code>%canon_reldir%_liboctinterp_current</code>
<!----------------------------------------------------------------------------->
+
** {{Path|libgui/module.mk}} <code>%canon_reldir%_liboctgui_current</code>
# Review documentation
 
#* Grammar check documentation so that it conforms to Octave standards
 
#* 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
 
#* Update major version number in "@subtitle Edition XXX" in octave.texi
 
#: Completion Date:
 
<!----------------------------------------------------------------------------->
 
# Localization and Internationalization
 
#* Update language translation files (*.ts)
 
#* Create issue report on Savannah as a centralized location for uploading files
 
#* Submit call for translations for GUI strings
 
#* Push translations provided by translators
 
#: Completion Date:
 
<!----------------------------------------------------------------------------->
 
#  Update shared library and oct file API version numbers
 
#* Increment oct file API version number (configure.ac:OCTAVE_API_VERSION, increment number and drop "+" suffix)
 
#* Increment libtool versioning (liboctave/module.mk:%canon_reldir%_%canon_reldir%_current, libinterp/module.mk:%canon_reldir%_liboctinterp_current, libgui/module.mk:%canon_reldir%_liboctgui_current)
 
#: Completion Date:
 
<!----------------------------------------------------------------------------->
 
# Verify build process and create release candidates
 
#* Update configure.ac with new version information
 
#**  Update AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION, OCTAVE_RELEASE_DATE
 
#* Verify 'make distcheck' passes
 
#* Create release candidate
 
#** 'make dist'
 
#** hg tag repository with release candidate ID
 
#** For Windows, create installer [[Windows Installer]]
 
#** Upload release candidate
 
#** Add release candidate version to Savannah bug tracker
 
#** Announce release candidate to Octave-Maintainers, Octave-Help, on web page
 
#** Repeat release candidate cycle until clean
 
#: Completion Date:
 
<!----------------------------------------------------------------------------->
 
# Final Release
 
#* Update version information
 
#** Update configure.ac (AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION, OCTAVE_RELEASE_DATE)
 
#** Update NEWS (final release date)
 
#** Update CITATION (version, year, URL)
 
#** Update org.octave.Octave.appdata.xml (version number and release date)
 
#* hg tag repository with release version number
 
#* merge default onto stable to become the current stable release
 
#* Savannah bug tracker version info
 
#** add new release version to bug tracker
 
#** remove release candidate versions from bug tracker
 
#* Announce final release on
 
#** Octave mailing lists
 
#** Octave web site
 
#** This wiki
 
#: Completion Date:
 
<!----------------------------------------------------------------------------->
 
# Post-Release
 
#* Update configure.ac (AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION) to next release cycle
 
#* Update oct file API version number (configure.ac:OCTAVE_API_VERSION, add "+" suffix)
 
#* Remove all deprecated functions (either OCTAVE_DEPRECATED in C++ or scripts/deprecated for m-files) scheduled for deletion in default branch
 
#* Move NEWS file to backup in etc/NEWS.X
 
#* Create new NEWS file
 
#: Completion Date:
 
  
 
[[Category:Releases]]
 
[[Category:Releases]]

Latest revision as of 01:49, 10 December 2019

Please use

<strike></strike>

to mark items as done.

Kickoff[edit]

Update gnulib to latest version[edit]

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

Call for bug reports[edit]

Completion Date:
  • Put out a general call for reports on maintainers@octave.org and help@octave.org for all outstanding unreported known bugs.

Review submitted patches on Savannah[edit]

Completion Date:
  • Submitted patches from bug tracker included.
  • Submitted patches from patch tracker included.

Review open bugs on Savannah[edit]

Completion Date:
  • Review bugs and update to correct category, such as "Patch submitted", correct title if necessary.
  • Add "must-fix" items to 6.1 Release Bug Fix List.

One time tasks[edit]

GPL License activities[edit]

Completion Date:
  • 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:
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.
  • m-file style check
  • C++ style check

Review documentation[edit]

Completion Date:
  • 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.
  • Update major version number in "@subtitle Edition XXX" in octave.texi.

Call for translations[edit]

Completion Date:
  • Update language translation files (*.ts).
  • Create issue report on Savannah as a centralized location for uploading files.
  • Call for translations for GUI strings on maintainers@octave.org.

Repeat until all bugs are resolved[edit]

Completion Date first iteration:

Merge submitted patches[edit]

  • Push translations provided by translators.
  • Push reviewed patches from Savannah.

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.
  • Start discussion on maintainers@octave.org about which failing tests that must be fixed and which can be declared WON'T FIX.

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 maintainers@octave.org, help@octave.org mailing-list, on web page.

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.
  • Remove release candidate versions from Savannah.

Announce final release[edit]

Completion Date:
  • Octave mailing-lists
  • Octave web site
  • This wiki

Post-Release[edit]

Completion Date:
  • Merge default onto stable to become the current stable release.
  • Ensure correct version information.
  • Remove all deprecated functions (either OCTAVE_DEPRECATED in C++ or scripts/deprecated for m-files) scheduled for deletion in "default" branch.
  • Move NEWS file to backup in etc/NEWS.X.
  • Create new NEWS file.

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