10.1 Release Checklist: Difference between revisions
m (Update memory leak instructions) |
m (Mark item done) |
||
(13 intermediate revisions by the same user not shown) | |||
Line 34: | Line 34: | ||
* Review bug overview at https://octave.space/savannah/. | * Review bug overview at https://octave.space/savannah/. | ||
=== ๐ข Update GUI translation files === | === ๐ข <strike> Update GUI translation files </strike> === | ||
Completion Date: | Completion Date: 2025-02-22 | ||
* WON'T DO <strike> Call for updates ([https://octave.discourse.group/ Octave Discourse]) that might change GUI strings. </strike> | * WON'T DO <strike> Call for updates ([https://octave.discourse.group/ Octave Discourse]) that might change GUI strings. </strike> | ||
Line 43: | Line 43: | ||
* Create bug report on Savannah as a centralized location for uploading files and tracking status of translations. | * Create bug report on Savannah as a centralized location for uploading files and tracking status of translations. | ||
* Call for translations of GUI strings on [https://octave.discourse.group/c/maintainers/7 Octave Discourse Maintainers], CC-ing the translators (see [https://hg.savannah.gnu.org/hgweb/octave/file/tip/libgui/languages/translators list of translators]). </strike> | * Call for translations of GUI strings on [https://octave.discourse.group/c/maintainers/7 Octave Discourse Maintainers], CC-ing the translators (see [https://hg.savannah.gnu.org/hgweb/octave/file/tip/libgui/languages/translators list of translators]). </strike> | ||
* Collect translation files on Savannah bug report and push to Mercurial. | * <strike> Collect translation files on Savannah bug report and push to Mercurial. </strike> | ||
=== โ๏ธ GPL License activities === | === โ๏ธ <strike> GPL License activities </strike> === | ||
Completion Date: | Completion Date: 2025-02-09 | ||
* <strike> Update copyright statements for all source controlled files. | * <strike> Update copyright statements for all source controlled files. | ||
Line 61: | Line 61: | ||
** <code>octave.texi, liboctave.texi, refcard.tex</code> </strike> | ** <code>octave.texi, liboctave.texi, refcard.tex</code> </strike> | ||
* Add any new contributors to <code>doc/interpreter/contributors.in</code> who wish to be mentioned (donโt add them without permission). | * <strike> Add any new contributors to <code>doc/interpreter/contributors.in</code> 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: 2025-02-26 | ||
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> | ||
* [https://wiki.octave.org/Octave_style_guide m-file style check] | * <strike> [https://wiki.octave.org/Octave_style_guide m-file style check] </strike> | ||
* [https://wiki.octave.org/C%2B%2B_style_guide C++ style check] | * <strike> [https://wiki.octave.org/C%2B%2B_style_guide C++ style check] </strike> | ||
=== ๐ Review documentation === | === ๐ <strike> Review documentation </strike> === | ||
Completion Date: | Completion Date: 2026-02-025 | ||
* <strike> Grammar check documentation (See <code>doc/interpreter/doccheck/README</code>). </strike> | * <strike> Grammar check documentation (See <code>doc/interpreter/doccheck/README</code>). </strike> | ||
* <strike> Spell check documentation (<code>make spellcheck</code>). </strike> | * <strike> Spell check documentation (<code>make spellcheck</code>). </strike> | ||
* Verify no functions missing from manual (<code>make doc/interpreter/undocumented_list</code>). | * <strike> Verify no functions missing from manual (<code>make doc/interpreter/undocumented_list</code>). </strike> | ||
* <strike> Verify deprecated functions removed from manual (<code>*.txi</code>) and from โsee alsoโ links. </strike> | * <strike> Verify deprecated functions removed from manual (<code>*.txi</code>) and from โsee alsoโ links. </strike> | ||
* <strike> Verify all formats (Info, HTML, PDF) build correctly. </strike> | * <strike> Verify all formats (Info, HTML, PDF) build correctly. </strike> | ||
* Review <code>etc/NEWS.10.md</code> for any features which should be announced. | * <strike> Review <code>etc/NEWS.10.md</code> for any features which should be announced. </strike> | ||
* WON'T DO <strike> Review <code>__unimplemented__.m</code> for the latest changes to [https://wiki.octave.org/Octave_Forge Octave Forge] packages and new Matlab functions. </strike> | * WON'T DO <strike> Review <code>__unimplemented__.m</code> for the latest changes to [https://wiki.octave.org/Octave_Forge Octave Forge] packages and new Matlab functions. </strike> | ||
* Update <code>installer-files/README.html</code> in MXE Octave with version highlights. | * <strike> Update <code>installer-files/README.html</code> in MXE Octave with version highlights. </strike> | ||
== ๐ Repeat until all bugs are resolved == | == ๐ Repeat until all bugs are resolved == | ||
Completion Date of first iteration: | Completion Date of first iteration: 2025-03-06 | ||
=== โ ๏ธ Current state at Savannah === | === โ ๏ธ Current state at Savannah === | ||
Line 96: | Line 96: | ||
=== โ
<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). | * <strike> 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). </strike> | ||
* Use software tools to check quality of Octave code. | * <strike> Use software tools to check quality of Octave code. | ||
** Check for memory leaks by configuring with <code>--enable-address-sanitizer-flags --disable-visibility-flags --disable-docs --disable-java</code> and compiling with <code>-g -O0</code> in <code>CFLAGS</code>, <code>CXXFLAGS</code>. | ** Check for memory leaks by configuring with <code>--enable-address-sanitizer-flags --disable-visibility-flags --disable-docs --disable-java</code> and compiling with <code>-g -O0</code> in <code>CFLAGS</code>, <code>CXXFLAGS</code>. | ||
** Check for bad memory accesses by configuring with <code>--disable-visibility-flags --disable-docs --disable-java</code> and compiling with <code>-g -O0 -fsanitize=undefined -fno-omit-frame-pointer</code> in <code>CFLAGS</code>, <code>CXXFLAGS</code>, and linking with <code>-fsanitize=undefined -fno-omit-frame-pointer</code> in <code>LDFLAGS</code>. | ** Check for bad memory accesses by configuring with <code>--disable-visibility-flags --disable-docs --disable-java</code> and compiling with <code>-g -O0 -fsanitize=undefined -fno-omit-frame-pointer</code> in <code>CFLAGS</code>, <code>CXXFLAGS</code>, and linking with <code>-fsanitize=undefined -fno-omit-frame-pointer</code> in <code>LDFLAGS</code>. </strike> | ||
** Update static code analysis results. | ** WON'T DO <strike> Update static code analysis results. | ||
*** For <code>clang</code>, do <code>scan-build make -j<N> all</code> and then <code>scan-view</code>. | *** For <code>clang</code>, do <code>scan-build make -j<N> all</code> and then <code>scan-view</code>. | ||
*** See [https://wiki.octave.org/PVS_static_analyzer_-_5.0_Release PVS static analyzer - 5.0 Release]. | *** See [https://wiki.octave.org/PVS_static_analyzer_-_5.0_Release PVS static analyzer - 5.0 Release]. </strike> | ||
** Use other tools such as <code>cppcheck</code>, etc. | ** WON'T DO <strike> Use other tools such as <code>cppcheck</code>, etc. </strike> | ||
* Start discussion on [https://octave.discourse.group/c/maintainers/8 Octave Discourse Maintainers] about which failing tests that must be fixed and which can be declared '''WONโT FIX'''. | * <strike> Start discussion on [https://octave.discourse.group/c/maintainers/8 Octave Discourse Maintainers] about which failing tests that must be fixed and which can be declared '''WONโT FIX'''. </strike> | ||
=== ๐ ๏ธ Create new release candidate === | === ๐ ๏ธ Create new release candidate === | ||
* Ensure correct version information (see โRelease Numberingโ in <code>/etc/HACKING.md</code>). | * <strike> Ensure correct version information (see โRelease Numberingโ in <code>/etc/HACKING.md</code>). | ||
* Create <code>hg tag</code> in repository with release candidate version number (<code>rc-MAJOR-MINOR-PATCH</code>). | * Create <code>hg tag</code> in repository with release candidate version number (<code>rc-MAJOR-MINOR-PATCH</code>). | ||
* Verify <code>make dist</code> works. | * Verify <code>make dist</code> works. | ||
* Verify <code>make distcheck</code> passes. | * Verify <code>make distcheck</code> passes. </strike> | ||
* Create [https://wiki.octave.org/Windows_Installer Windows Installer]. | * <strike> Create [https://wiki.octave.org/Windows_Installer Windows Installer]. | ||
* Upload release candidates to https://alpha.gnu.org/gnu/octave/. | * Upload release candidates to https://alpha.gnu.org/gnu/octave/. | ||
* Check [https://wiki.octave.org/Windows_Installer Windows Installer] (executable and zip formats) against false positive detection at [https://virustotal.com/ virustotal.com]. | * Check [https://wiki.octave.org/Windows_Installer Windows Installer] (executable and zip formats) against false positive detection at [https://virustotal.com/ virustotal.com]. | ||
* Add release candidate version to Savannah bug tracker. | * Add release candidate version to Savannah bug tracker. | ||
* Announce release candidate to [https://octave.discourse.group/ Octave Discourse]. | * Announce release candidate to [https://octave.discourse.group/ Octave Discourse]. </strike> | ||
== ๐ Final Release ๐ == | == ๐ Final Release ๐ == |
Latest revision as of 16:38, 9 March 2025
- 2025-02-07 ๐ Release Kick-off โฝ (default branch merged to stable)
- 2025-03-15 ๐ ๏ธ 1st release candidate 10.0.90 on https://alpha.gnu.org/gnu/octave/
- 2025-04-01 ๐ Final Release ๐ 10.1.0 on https://ftp.gnu.org/gnu/octave/
Please use <strike> </strike>
to mark items below as done.
๐ Kick-off โฝ
โ๏ธ Update stable and default branch to new version numbers
Completion Date: 2025-02-07
Merge default onto stable to become the current stable release (see instructions inetc/HACKING.md
).- Bump version numbers in
configure.ac
on stable branch (seeetc/HACKING.md
). - Bump version numbers in
configure.ac
on default branch (seeetc/HACKING.md
). Create newetc/NEWS.11.md
file on default branch by copyingetc/NEWS.10.md
and then removing text so that it is a template file with headings only.
โ๏ธ Update gnulib to latest version
Completion Date: 2025-02-08
Must occur first as it could resolve existing, or create new, bug reports. The simple update command is
gnulib-tool --add-import
followed by running ./bootstrap
in the source tree.
๐ข Call for bug reports
Completion Date: 2025-02-07
- WON'T DO
Put out a general call for reports on Octave Discourse for all outstanding, but unreported, known bugs. Create SavannahRelease
tag10.0.90
on bug tracker for 1st release candidate.- Mark items that should be fixed for the release with this tag.
Update SavannahPlanned Release
andFixed Release
tags by adding10.1.0 (current stable)
and11.1.0 (current default)
.- Review bug overview at https://octave.space/savannah/.
๐ข Update GUI translation files
Completion Date: 2025-02-22
- WON'T DO
Call for updates (Octave Discourse) that might change GUI strings. - String freeze date: 2025-02-07
Update language translation files (*.ts
). See instructions inlibgui/languages/build_ts/README.md
.- Create bug report on Savannah as a centralized location for uploading files and tracking status of translations.
Call for translations of GUI strings on Octave Discourse Maintainers, CC-ing the translators (see list of translators).Collect translation files on Savannah bug report and push to Mercurial.
โ๏ธ GPL License activities
Completion Date: 2025-02-09
Update copyright statements for all source controlled files.
- Command to update copyright notifications
hg locate | xargs sed -i 's/Copyright (C) \([0-9][0-9][0-9][0-9]\)-2023 The Octave Project Developers/Copyright (C) \1-2024 The Octave Project Developers/; s/Copyright (C) 2023 The Octave Project Developers/Copyright (C) 2023-2024 The Octave Project Developers/'
- Command to check results before checking in
hg diff | grep ^[-+][^-+] | sed 's/[0-9][0-9][0-9][0-9]-/YYYY-/' | sort -u
Update dates in any other locations- MXE
README.html
file octave.texi, liboctave.texi, refcard.tex
- MXE
Add any new contributors todoc/interpreter/contributors.in
who wish to be mentioned (donโt add them without permission).
โ
Style-check code base
Completion Date: 2025-02-26
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
Completion Date: 2026-02-025
Grammar check documentation (Seedoc/interpreter/doccheck/README
).Spell check documentation (make spellcheck
).Verify no functions missing from manual (make doc/interpreter/undocumented_list
).Verify deprecated functions removed from manual (*.txi
) and from โsee alsoโ links.Verify all formats (Info, HTML, PDF) build correctly.Reviewetc/NEWS.10.md
for any features which should be announced.- WON'T DO
Review__unimplemented__.m
for the latest changes to Octave Forge packages and new Matlab functions. Updateinstaller-files/README.html
in MXE Octave with version highlights.
๐ Repeat until all bugs are resolved
Completion Date of first iteration: 2025-03-06
โ ๏ธ Current state at Savannah
Bug overview at https://octave.space/savannah/.
โ
make check
Verifymake check
is passing on all buildbot combinations of OS and compilers and GitHub CI runners. Also check test suite runs on โfreshly brewed Octave for Windowsโ (Kaiโs buildbots on octave.space).Use software tools to check quality of Octave code.- Check for memory leaks by configuring with
--enable-address-sanitizer-flags --disable-visibility-flags --disable-docs --disable-java
and compiling with-g -O0
inCFLAGS
,CXXFLAGS
. Check for bad memory accesses by configuring with--disable-visibility-flags --disable-docs --disable-java
and compiling with-g -O0 -fsanitize=undefined -fno-omit-frame-pointer
inCFLAGS
,CXXFLAGS
, and linking with-fsanitize=undefined -fno-omit-frame-pointer
inLDFLAGS
.- WON'T DO
Update static code analysis results.- For
clang
, doscan-build make -j<N> all
and thenscan-view
. See PVS static analyzer - 5.0 Release.
- For
- WON'T DO
Use other tools such ascppcheck
, etc.
- Check for memory leaks by configuring with
Start discussion on Octave Discourse Maintainers about which failing tests that must be fixed and which can be declared WONโT FIX.
๐ ๏ธ Create new release candidate
Ensure correct version information (see โRelease Numberingโ in/etc/HACKING.md
).- Create
hg tag
in repository with release candidate version number (rc-MAJOR-MINOR-PATCH
). - Verify
make dist
works. Verifymake distcheck
passes.Create Windows Installer.- Upload release candidates to https://alpha.gnu.org/gnu/octave/.
- 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 ๐
๐ Update version information
Completion Date:
- Ensure correct version information in
configure.ac
(see โRelease Numberingโ in/etc/HACKING.md
)- Set
OCTAVE_RELEASE_DATE
to the current date. - Set the year in
OCTAVE_COPYRIGHT
to the current year.
- Set
- Create
hg tag
in repository with release candidate version number (release-10-1-0
). - Update
etc/NEWS.10.md
(final release date in Summary header). - Update
CITATION
(version, year, URL) if not already done as part of "GPL License activities. - Update
etc/icons/org.octave.Octave.appdata.xml
(version number and release date). - Upload all tarballs to https://ftp.gnu.org/gnu/octave/.
- Update web site files:
NEWS-10.html
,index.in
,news.in
, anddownload.in
. - Update https://wiki.octave.org/Release_History page.
- Update Savannah bug tracker
Release
field to have new release number. - Update Savannah bug tracker: OPEN bugs marked as WONโT FIX should be marked as CONFIRMED (or more appropriate) for the final release.
- Hide release candidate versions for
Release
field on Savannah.
๐ข Announce final release
Completion Date:
- Octave mailing-lists (yes, still) help@octave.org and info-gnu@gnu.org.
- Octave web site (https://hg.octave.org/web-octave)
- Steps documented in this changeset.
- Upload documentation (manual HTML + PDF
octave.org/doc
and version inoctave.org/.htaccess
, Doxygenoctave.org/doxygen
) - This wiki
- Template:Release = 9.4.0
- Template:Release Date = February 5, 2025
- Template:Release Year = 2025
โ๏ธ Post-Release
Completion Date: 2025-02-08
Remove all deprecated functions scheduled for deletion on default branch. These functions are tagged withOCTAVE_DEPRECATED
in C++ or are m-files located in the directoryscripts/deprecated
. Check fileetc/NEWS.9.md
for list of features that have been deprecated.