10.1 Release Checklist
Jump to navigation
Jump to search
βοΈ
βοΈ
π’
β
Timeline (tentative)
- 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:
- 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:
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 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.
π Review documentation
Completion Date:
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.- Review
etc/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. - Update
installer-files/README.html
in MXE Octave with version highlights.
π Repeat until all bugs are resolved
Completion Date of first iteration:
β οΈ Current state at Savannah
Bug overview at https://octave.space/savannah/.
β
make check
- Verify
make 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
. - Update static code analysis results.
- For
clang
, doscan-build make -j<N> all
and thenscan-view
. - See PVS static analyzer - 5.0 Release.
- For
- Use other tools such as
cppcheck
, 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. - Verify
make 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.