Mercurial > octave

annotate etc/RELEASE.CHECKLIST @ 30239:120e878f343f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mkdir.m: issue a warning if DIR already exists (bug #61338) * mkdir.m: When nargout==0, check status message and report a warning if "directory exists" message found.
author Rik <rik@octave.org>
date Wed, 13 Oct 2021 08:05:14 -0700
parents 59bd02077bf3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
1 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
2 <! This file contains a list of steps to accomplish before producing a release.
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
3 The format of the file is wiki markup and can be directly used as a page
26223
db43bd1fc038 build: Add wiki files for release process.
Rik <rik@octave.org>
parents: 25341
diff changeset
4 on wiki.octave.org. >
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
5 <!----------------------------------------------------------------------------->
26628
fb100b270550 maint: update release checklists for version 6
Mike Miller <mtmiller@octave.org>
parents: 26583
diff changeset
6 ==6.0.0 Release Tasks==
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
7
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
8 <!----------------------------------------------------------------------------->
25079
5a8442dbd744 RELEASE.PROCESS: Add new step to update gnulib, check buildbots for failures.
Rik <rik@octave.org>
parents: 21981
diff changeset
9 # Update gnulib to latest version
26223
db43bd1fc038 build: Add wiki files for release process.
Rik <rik@octave.org>
parents: 25341
diff changeset
10 #: Must occur first as it could resolve existing, or create new, bug reports
25079
5a8442dbd744 RELEASE.PROCESS: Add new step to update gnulib, check buildbots for failures.
Rik <rik@octave.org>
parents: 21981
diff changeset
11 #: Completion Date:
5a8442dbd744 RELEASE.PROCESS: Add new step to update gnulib, check buildbots for failures.
Rik <rik@octave.org>
parents: 21981
diff changeset
12 <!----------------------------------------------------------------------------->
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
13 # File bug reports for all outstanding bugs known, but not reported
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
14 #* Put out a general call for reports on Octave-Maintainers and Octave-Help list
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
15 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
16 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
17 # Review patch tracker/bug list for any patches submitted that may be included before release
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
18 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
19 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
20 # Identify Bugs which *must* be fixed prior to release
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
21 #* Review bugs on tracker for possible inclusion in list
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
22 #* Review bugs and update to correct category, such as Patch submitted
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
23 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
24 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
25 # Clear all bugs identified as must-fix
26628
fb100b270550 maint: update release checklists for version 6
Mike Miller <mtmiller@octave.org>
parents: 26583
diff changeset
26 #* See [[Bug Fix List - 6.0 Release]]
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
27 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
28 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
29 # GPL License activities
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
30 #* Update Copyright statements for all source controlled files
25230
b68abed2db20 Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25082
diff changeset
31 #* Update dates in any other locations (launch message, citation, MXE files, etc.)
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
32 #* Add any new contributors to contributors.in
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
33 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
34 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
35 # Style-check code base
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
36 #* This will produce lots of whitespace changes, but no behavior changes
25230
b68abed2db20 Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25082
diff changeset
37 #* Must occur after patches have been added since whitespace changes can prevent patches from applying
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
38 #* m-file style check. Completion Date:
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
39 #* C++ style check. Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
40 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
41 # Run lint checker on code base
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
42 #* Possibilities include compiling with -fsanitize=undefined and running 'make check', cppcheck, etc.
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
43 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
44 <!----------------------------------------------------------------------------->
25082
3166d47adde2 RELEASE.PROCESS: Update checklist for making a release.
Rik <rik@octave.org>
parents: 25079
diff changeset
45 # Verify 'make check' is passing on all buildbot combinations of OS and compilers
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
46 #* Start discussion on octave-maintainers list about which failing tests must be fixed
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
47 #* Identify and fix any tests determined critical in step above
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
48 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
49 <!----------------------------------------------------------------------------->
21981
638fca9a173f RELEASE.PROCESS: Update notes for 4.2.0 release.
Rik <rik@octave.org>
parents: 20715
diff changeset
50 # Compile and run Octave test suite with --enable-address-sanitizer-flags to check for memory leaks
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20065
diff changeset
51 #* Results posted to bug report:
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
52 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
53 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
54 # Review documentation
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
55 #* Grammar check documentation so that it conforms to Octave standards
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
56 #* Spell check documentation
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
57 #* Verify no functions missing from manual
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
58 #* Verify deprecated functions removed from "see also" links
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
59 #* Verify all formats (Info, HTML, pdf) build correctly
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
60 #* Review NEWS for any features which should be announced
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
61 #* Update major version number in "@subtitle Edition XXX" in octave.texi
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
62 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
63 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
64 # Localization and Internationalization
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
65 #* Update language translation files (*.ts)
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
66 #* Create issue report on Savannah as a centralized location for uploading files
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
67 #* Submit call for translations for GUI strings
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
68 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
69 <!----------------------------------------------------------------------------->
26583
70c5235df63a maint: bump library and oct file versions earlier in the release process
Mike Miller <mtmiller@octave.org>
parents: 26223
diff changeset
70 # Update shared library and oct file API version numbers
26806
59bd02077bf3 maint: reintroduce OCTAVE_API_VERSION development suffix
Mike Miller <mtmiller@octave.org>
parents: 26628
diff changeset
71 #* Increment oct file API version number (configure.ac:OCTAVE_API_VERSION, increment number and drop "+" suffix)
26583
70c5235df63a maint: bump library and oct file versions earlier in the release process
Mike Miller <mtmiller@octave.org>
parents: 26223
diff changeset
72 #* 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)
26628
fb100b270550 maint: update release checklists for version 6
Mike Miller <mtmiller@octave.org>
parents: 26583
diff changeset
73 #: Completion Date:
26583
70c5235df63a maint: bump library and oct file versions earlier in the release process
Mike Miller <mtmiller@octave.org>
parents: 26223
diff changeset
74 <!----------------------------------------------------------------------------->
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
75 # Verify build process and create release candidates
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
76 #* Update configure.ac with new version information
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
77 #** Update AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION, OCTAVE_RELEASE_DATE
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
78 #* Verify 'make distcheck' passes
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
79 #* Create release candidate
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
80 #** 'make dist'
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
81 #** hg tag repository with release candidate ID
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
82 #** For Windows, create installer [[Windows Installer]]
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
83 #** Upload release candidate
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
84 #** Add release candidate version to Savannah bug tracker
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
85 #** Announce release candidate to Octave-Maintainers, Octave-Help, on web page
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
86 #** Repeat release candidate cycle until clean
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
87 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
88 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
89 # Final Release
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
90 #* Update version information
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
91 #** Update configure.ac (AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION, OCTAVE_RELEASE_DATE)
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
92 #** Update NEWS (final release date)
25341
224779b7c094 RELEASE.PROCESS: Add updating CITATION file to checklist.
Rik <rik@octave.org>
parents: 25335
diff changeset
93 #** Update CITATION (version, year, URL)
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
94 #** Update org.octave.Octave.appdata.xml (version number and release date)
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
95 #* hg tag repository with release version number
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
96 #* merge default onto stable to become the current stable release
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
97 #* Savannah bug tracker version info
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
98 #** add new release version to bug tracker
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
99 #** remove release candidate versions from bug tracker
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
100 #* Announce final release on Octave mailing lists and web site
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
101 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
102 <!----------------------------------------------------------------------------->
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
103 # Post-Release
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
104 #* Update configure.ac (AC_INIT, OCTAVE_MAJOR_VERSION, OCTAVE_MINOR_VERSION, OCTAVE_PATCH_VERSION) to next release cycle
26806
59bd02077bf3 maint: reintroduce OCTAVE_API_VERSION development suffix
Mike Miller <mtmiller@octave.org>
parents: 26628
diff changeset
105 #* Update oct file API version number (configure.ac:OCTAVE_API_VERSION, add "+" suffix)
25335
28641f4be5de Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25230
diff changeset
106 #* Remove all deprecated functions (either OCTAVE_DEPRECATED in C++ or scripts/deprecated for m-files) scheduled for deletion in default branch
25230
b68abed2db20 Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25082
diff changeset
107 #* Move NEWS file to backup in etc/NEWS.X
b68abed2db20 Update RELEASE.PROCESS checklist.
Rik <rik@octave.org>
parents: 25082
diff changeset
108 #* Create new NEWS file
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
109 #: Completion Date:
18050
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
110
2d3b1037fd12 Add template checklist for making a release to source control.
Rik <rik@octave.org>
parents:
diff changeset
111 [[Category:Releases]]
20065
def977567637 Update reference document with Release Tasks.
Rik <rik@octave.org>
parents: 18050
diff changeset
112 [[Category:Development]]