Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 49f8a99

Browse filesBrowse files
timhoffmtimhoffm
committed
Adapt the release guide to the new release notes structure
1 parent 0e16de7 commit 49f8a99
Copy full SHA for 49f8a99

File tree

Expand file treeCollapse file tree

3 files changed

+42
-39
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+42
-39
lines changed

‎doc/api/next_api_changes.rst

Copy file name to clipboardExpand all lines: doc/api/next_api_changes.rst
-11Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,6 @@ Next API changes
55

66
.. ifconfig:: releaselevel == 'dev'
77

8-
.. note::
9-
10-
The list below is a table of contents of individual files from the
11-
most recent :file:`api_changes_X.Y` folder.
12-
13-
When a release is made
14-
15-
- The include directive below should be changed to point to the new file
16-
created in the previous step.
17-
18-
198
.. toctree::
209
:glob:
2110
:maxdepth: 1

‎doc/devel/release_guide.rst

Copy file name to clipboardExpand all lines: doc/devel/release_guide.rst
+42-15Lines changed: 42 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,27 +101,54 @@ When making major or minor releases, update the supported versions in the
101101
Security Policy in :file:`SECURITY.md`. Commonly, this may be one or two
102102
previous minor releases, but is dependent on release managers.
103103

104-
Update "What's new" and "API changes"
105-
-------------------------------------
104+
Update release notes
105+
--------------------
106106

107-
Before tagging major and minor releases, the "what's new" and "API changes"
108-
listings should be updated. This is not needed for micro releases.
107+
What's new
108+
~~~~~~~~~~
109109

110-
For the "what's new",
110+
*Only needed for major and minor releases. Bugfix releases should not have new
111+
features.*
111112

112-
1. copy the current content to a file in :file:`doc/users/prev_whats_new`
113-
2. merge all of the files in :file:`doc/users/next_whats_new/` into
114-
:file:`doc/users/whats_new.rst` and delete the individual files
115-
3. comment out the next what's new glob at the top
113+
Merge the contents of all the files in :file:`doc/users/next_whats_new/`
114+
into a single file :file:`doc/users/prev_whats_new/whats_new_X.Y.0.rst`
115+
and delete the individual files.
116116

117-
Similarly for the "API changes",
117+
API changes
118+
~~~~~~~~~~~
118119

119-
1. copy the current api changes to a file is :file:`doc/api/prev_api_changes`
120-
2. merge all of the files in the most recent :file:`doc/api/next_api_changes`
121-
into :file:`doc/api/api_changes.rst`
122-
3. comment out the most recent API changes at the top.
120+
*Primarily needed for major and minor releases. We may sometimes have API
121+
changes in bugfix releases.*
123122

124-
In both cases step 3 will have to be un-done right after the release.
123+
Merge the contents of all the files in :file:`doc/api/next_api_changes/`
124+
into a single file :file:`doc/api/prev_api_changes/api_changes_X.Y.Z.rst`
125+
and delete the individual files.
126+
127+
Release notes TOC
128+
~~~~~~~~~~~~~~~~~
129+
130+
Update :file:`doc/users/release_notes.rst`:
131+
132+
- For major and minor releases add a new section
133+
134+
.. code:: rst
135+
136+
X.Y
137+
===
138+
.. toctree::
139+
:maxdepth: 1
140+
141+
prev_whats_new/whats_new_X.Y.0.rst
142+
../api/prev_api_changes/api_changes_X.Y.0.rst
143+
prev_whats_new/github_stats_X.Y.0.rst
144+
145+
- For bugfix releases add the GitHub stats and (if present) the API changes to
146+
the existing X.Y section
147+
148+
.. code:: rst
149+
150+
../api/prev_api_changes/api_changes_X.Y.Z.rst
151+
prev_whats_new/github_stats_X.Y.Z.rst
125152
126153
Verify that docs build
127154
----------------------

‎doc/users/next_whats_new.rst

Copy file name to clipboardExpand all lines: doc/users/next_whats_new.rst
-13Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,6 @@ Next what's new?
66

77
.. ifconfig:: releaselevel == 'dev'
88

9-
.. note::
10-
11-
The list below is a table of contents of individual files from the
12-
'next_whats_new' folder.
13-
14-
When a release is made
15-
16-
- All the files in 'next_whats_new/' should be moved to a single file in
17-
'prev_whats_new/'.
18-
- The include directive below should be changed to point to the new file
19-
created in the previous step.
20-
21-
229
.. toctree::
2310
:glob:
2411
:maxdepth: 1

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.