Difference between revisions of "Release Checklist"

From Octave
Jump to navigation Jump to search
(Split major categories.)
(→‎Final Release: Overhaul section.)
Line 92: Line 92:
 
== Final Release ==
 
== Final Release ==
  
#* Update version information
+
=== Update version information ===
#** Update configure.ac (AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION, OCTAVE_RELEASE_DATE)
+
:Completion Date:
#** Update NEWS (final release date)
+
* Update configure.ac (AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION, OCTAVE_RELEASE_DATE).
#** Update CITATION (version, year, URL)
+
* Update {{Path|NEWS}} (final release date).
#** Update org.octave.Octave.appdata.xml (version number and release date)
+
* Update {{Path|CITATION}} (version, year, URL).
#* hg tag repository with release version number
+
* Update {{Path|org.octave.Octave.appdata.xml}} (version number and release date).
#* merge default onto stable to become the current stable release
+
* Create hg tag in repository with release version number.
#* Savannah bug tracker version info
+
* Merge default onto stable to become the current stable release.
#** add new release version to bug tracker
+
 
#** remove release candidate versions from bug tracker
+
* Update Savannah bug tracker version info.
#* Announce final release on
+
* Remove release candidate versions from Savannah.
#** Octave mailing lists
+
 
#** Octave web site
+
=== Announce final release ===
#** This wiki
+
:Completion Date:
#: Completion Date:
+
* Octave mailing-lists
 +
* Octave web site
 +
* This wiki
  
 
== Post-Release ==
 
== Post-Release ==

Revision as of 00:43, 10 December 2019

Please use

<strike></strike>

to mark items as done.

Kickoff

Update gnulib to latest version

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.

File bug reports

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.

Review submitted patches on Savannah

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

Review open bugs on Savannah

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.

GPL License activities

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 contributors.in who wish to be mentioned (don't add them without permission).

Style-check code base

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


Repeat until all bugs are resolved

Run lint checker on code base

Completion Date:
  1. Verify 'make check' is passing on all buildbot combinations of OS and compilers
    • Start discussion on octave-maintainers list about which failing tests must be fixed
    • Identify and fix any tests determined critical in step above
    Completion Date:
  2. Compile and run Octave test suite with --enable-address-sanitizer-flags to check for memory leaks
    Completion Date:
  3. 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:
  4. 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:
  5. 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:
  6. 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

Completion Date:
  • 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).
  • Create hg tag in repository with release version number.
  • Merge default onto stable to become the current stable release.
  • Update Savannah bug tracker version info.
  • Remove release candidate versions from Savannah.

Announce final release

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

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: