1,134
edits
10.1 Release Checklist: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
mNo edit summary |
mNo edit summary |
||
| Line 10: | Line 10: | ||
------------------------------------------------------------ | ------------------------------------------------------------ | ||
=== ⚙️ Update stable and default branch to new version numbers === | |||
Completion Date: | Completion Date: | ||
| Line 20: | Line 20: | ||
* Bump version numbers in `configure.ac` on default branch (see | * Bump version numbers in `configure.ac` on default branch (see | ||
`etc/HACKING.md`). | `etc/HACKING.md`). | ||
* Create new `etc/NEWS. | * Create new `etc/NEWS.VERSION+1.md` file on default branch by copying | ||
`etc/NEWS. | `etc/NEWS.VERSION.md` and then removing text so that it is a template file | ||
with headings only. | with headings only. | ||
=== ⚙️ Update gnulib to latest version === | |||
Completion Date: | Completion Date: | ||
| Line 32: | Line 32: | ||
gnulib version. | gnulib version. | ||
=== 📢 Call for bug reports === | |||
Completion Date: | Completion Date: | ||
* Put out a general call for reports on [Octave Discourse](https://octave.discourse.group/) for all outstanding, but unreported, known bugs. | * Put out a general call for reports on [Octave Discourse](https://octave.discourse.group/) for all outstanding, but unreported, known bugs. | ||
* Create Savannah `Release` tag ` | * Create Savannah `Release` tag `VERSION.0.90` on bug tracker for 1st release | ||
candidate. | candidate. | ||
* Mark items that should be fixed for the release with this tag. | * Mark items that should be fixed for the release with this tag. | ||
* Update Savannah `Planned Release` and `Fixed Release` tags by adding | * Update Savannah `Planned Release` and `Fixed Release` tags by adding | ||
` | `VERSION.1.0 (current stable)` and `VERSION+1.1.0 (current default)`. | ||
* Review bug overview at <https://octave.space/savannah/>. | * Review bug overview at <https://octave.space/savannah/>. | ||
=== 📢 Update GUI translation files === | |||
Completion Date: | Completion Date: | ||
| Line 58: | Line 58: | ||
* Collect translation files on Savannah bug report and push to Mercurial. | * Collect translation files on Savannah bug report and push to Mercurial. | ||
=== ⚖️ GPL License activities === | |||
Completion Date: | Completion Date: | ||
| Line 76: | Line 76: | ||
mentioned (don't add them without permission). | mentioned (don't add them without permission). | ||
=== ✅ Style-check code base === | |||
Completion Date: | Completion Date: | ||
| Line 87: | Line 87: | ||
* [C++ style check](https://wiki.octave.org/C%2B%2B_style_guide) | * [C++ style check](https://wiki.octave.org/C%2B%2B_style_guide) | ||
=== 📖 Review documentation === | |||
Completion Date: | Completion Date: | ||
| Line 98: | Line 98: | ||
links. | links. | ||
* Verify all formats (Info, HTML, PDF) build correctly. | * Verify all formats (Info, HTML, PDF) build correctly. | ||
* Review `etc/NEWS. | * Review `etc/NEWS.VERSION.md` for any features which should be announced. | ||
* Review `__unimplemented__.m` for the latest changes to | * Review `__unimplemented__.m` for the latest changes to | ||
[Octave Forge](https://wiki.octave.org/Octave_Forge) packages and new Matlab | [Octave Forge](https://wiki.octave.org/Octave_Forge) packages and new Matlab | ||
| Line 104: | Line 104: | ||
* Update `installer-files/README.html` in MXE Octave with version highlights. | * Update `installer-files/README.html` in MXE Octave with version highlights. | ||
== 🔃 Repeat until all bugs are resolved == | |||
------------------------------------------------------------ | ------------------------------------------------------------ | ||
| Line 110: | Line 110: | ||
Completion Date of first iteration: | Completion Date of first iteration: | ||
=== ⚠️ Current state at Savannah === | |||
Bug overview at <https://octave.space/savannah/>. | Bug overview at <https://octave.space/savannah/>. | ||
=== ✅ `make check` === | |||
* Verify `make check` is passing on all [buildbot combinations of OS and compilers](http://buildbot.octave.org:8010/ | * Verify `make check` is passing on all [buildbot combinations of OS and compilers](http://buildbot.octave.org:8010/=/waterfall) and [GitHub CI runners](https://github.com/gnu-octave/octave/actions). Also check [test suite runs on "freshly brewed Octave for Windows"](https://github.com/gnu-octave/octave-buildbot/actions) (Kai's buildbots on octave.space). | ||
* Use software tools to check quality of Octave code. | * Use software tools to check quality of Octave code. | ||
* Check for memory leaks by configuring with | * Check for memory leaks by configuring with | ||
| Line 131: | Line 131: | ||
* Start discussion on [Octave Discourse Maintainers](https://octave.discourse.group/c/maintainers/8) about which failing tests that must be fixed and which can be declared **WON'T FIX**. | * Start discussion on [Octave Discourse Maintainers](https://octave.discourse.group/c/maintainers/8) 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 | * Ensure correct version information (see "Release Numbering" in | ||
| Line 148: | Line 148: | ||
[Octave Discourse](https://octave.discourse.group/). | [Octave Discourse](https://octave.discourse.group/). | ||
== 🏁 Final Release 🎉 == | |||
------------------------------------------------------------ | ------------------------------------------------------------ | ||
=== 📃 Update version information === | |||
Completion Date: | Completion Date: | ||
| Line 161: | Line 161: | ||
* Set the year in `OCTAVE_COPYRIGHT` to the current year. | * Set the year in `OCTAVE_COPYRIGHT` to the current year. | ||
* Create `hg tag` in repository with release candidate version number | * Create `hg tag` in repository with release candidate version number | ||
(`release- | (`release-VERSION-1-0`). | ||
* Update `etc/NEWS. | * Update `etc/NEWS.VERSION.md` (final release date in Summary header). | ||
* Update `CITATION` (version, year, URL) if not already done as part of "GPL | * Update `CITATION` (version, year, URL) if not already done as part of "GPL | ||
License activities. | License activities. | ||
| Line 168: | Line 168: | ||
date). | date). | ||
* Upload all tarballs to <https://ftp.gnu.org/gnu/octave/>. | * Upload all tarballs to <https://ftp.gnu.org/gnu/octave/>. | ||
* Update web site files: `NEWS- | * Update web site files: `NEWS-VERSION.html`, `index.in`, `news.in`, and | ||
`download.in`. | `download.in`. | ||
* Update <https://wiki.octave.org/Release_History> page. | * Update <https://wiki.octave.org/Release_History> page. | ||
| Line 176: | Line 176: | ||
* Hide release candidate versions for `Release` field on Savannah. | * Hide release candidate versions for `Release` field on Savannah. | ||
=== 📢 Announce final release === | |||
Completion Date: | Completion Date: | ||
| Line 191: | Line 191: | ||
* Template:Release Year = 2022 | * Template:Release Year = 2022 | ||
=== ☑️ Post-Release === | |||
Completion Date: | Completion Date: | ||
| Line 198: | Line 198: | ||
branch. These functions are tagged with `OCTAVE_DEPRECATED` in C++ or are | branch. These functions are tagged with `OCTAVE_DEPRECATED` in C++ or are | ||
m-files located in the directory `scripts/deprecated`. Check file | m-files located in the directory `scripts/deprecated`. Check file | ||
`etc/NEWS. | `etc/NEWS.VERSION-2.md` for list of features that have been deprecated. | ||