Release Checklist: Difference between revisions
Jump to navigation
Jump to search
(Centralize version information.) |
|||
(6 intermediate revisions by the same user not shown) | |||
Line 13: | Line 13: | ||
=== Call for 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 | * 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 31: | 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 | ||
Line 60: | Line 60: | ||
=== Merge submitted patches === | === Merge submitted patches === | ||
* Push translations provided by translators. | * Push translations provided by translators. | ||
* | * Push reviewed patches from Savannah. | ||
=== <code>make check</code> === | === <code>make check</code> === | ||
Line 70: | Line 70: | ||
=== Create new release candidate === | === Create new release candidate === | ||
* Ensure correct [[#Versioning hints|version information]]. | * 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 distcheck</code> passes. | ||
* Verify <code>make dist</code> works. | * Verify <code>make dist</code> works. | ||
* Create [[Windows Installer]]. | * Create [[Windows Installer]]. | ||
* Upload release candidates. | * Upload release candidates. | ||
* Add release candidate version to Savannah bug tracker. | * Add release candidate version to Savannah bug tracker. | ||
* Announce release candidate to | * Announce release candidate to maintainers@octave.org, help@octave.org mailing-list, on web page. | ||
== Final Release == | == Final Release == | ||
Line 83: | Line 83: | ||
:Completion Date: | :Completion Date: | ||
* Ensure correct [[#Versioning hints|version information]]. | * Ensure correct [[#Versioning hints|version information]]. | ||
* Create hg tag in repository with release version number. | |||
* Update {{Path|NEWS}} (final release date). | * Update {{Path|NEWS}} (final release date). | ||
* Update {{Path|CITATION}} (version, year, URL). | * Update {{Path|CITATION}} (version, year, URL). | ||
* Update {{Path|org.octave.Octave.appdata.xml}} (version number and release date). | * Update {{Path|org.octave.Octave.appdata.xml}} (version number and release date). | ||
* Update Savannah bug tracker version info. | * Update Savannah bug tracker version info. | ||
* Remove release candidate versions from Savannah. | * Remove release candidate versions from Savannah. | ||
Line 100: | Line 98: | ||
== Post-Release == | == Post-Release == | ||
:Completion Date: | :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. | * 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}}. | * Move {{Path|NEWS}} file to backup in {{Path|etc/NEWS.X}}. | ||
Line 108: | Line 106: | ||
== Versioning hints == | == 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}}: | * Update {{Path|configure.ac}}: | ||
** <code>AC_INIT</code> | ** <code>AC_INIT</code> |
Revision as of 08:49, 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.
Call for bug reports
- 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
- 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.
One time tasks
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 doc/interpreter/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
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 NEWS for any features which should be announced.
- Update major version number in "@subtitle Edition XXX" in 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
- Completion Date first iteration:
Merge submitted patches
- Push translations provided by translators.
- Push reviewed patches from Savannah.
make check
- 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 toolscppcheck
, 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 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
Update version information
- 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
- Completion Date:
- Octave mailing-lists
- Octave web site
- This wiki
Post-Release
- 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
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
- liboctave/module.mk