You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: package/README.md
+25-8
Original file line number
Diff line number
Diff line change
@@ -67,12 +67,28 @@ Here is an overview of the release process. See the section below for detailed i
67
67
68
68
1. Assemble release notes.
69
69
70
-
* Since most changes are integrated into master using squash-rebase policy (i.e. one commit per PR), `git log --oneline` gives a good overview of changes in the release.
70
+
* Since most changes are integrated into master using squash-rebase policy (i.e. one commit per PR), `git log --oneline` gives a good overview of changes in the release.
71
71
72
-
* Prepare release notes in Markdown format.
72
+
* Prepare release notes in Markdown format.
73
73
74
-
* Combine related changes into the following categories, in that order:
74
+
* For changes that are breaking, duplicate those changes and put the duplicate lines into a separate group called Breaking Changes. That group should go at the top of the Changelog. The original lines for the breaking changes should be marked by appending "(Breaking change)" to the line. Example:
75
+
76
+
```
77
+
Breaking Changes
78
+
================
79
+
API xyz changed #1234
80
+
...
81
+
82
+
Library - xyz
83
+
=============
84
+
API xyz changed #1234 (Breaking change)
85
+
...
86
+
```
87
+
88
+
89
+
* Combine related changes into the following categories, in that order, including breaking changes with the appended mark:
75
90
91
+
- Breaking Changes
76
92
- Core
77
93
- *Libraries* — one section per library that received changes. If library only had a single change or a few changes, it is also okay to combine changes to a few such libraries under single "Other Libraries" entry.
78
94
- Upstream dependencies
@@ -116,11 +132,12 @@ The following points assume work in a direct clone of the repository, and not in
116
132
117
133
10. Create a commit to the master branch, updating:
118
134
119
-
* The version in platform.txt file. This should correspond to the version of the *next* milestone, plus `-dev` suffix. E.g. `2.5.0-dev`.
135
+
* The version in platform.txt file. This should correspond to the version of the *next* milestone, plus `-dev` suffix. E.g. `2.5.0-dev`.
120
136
121
-
* In main README.md:
137
+
* In main README.md:
122
138
123
-
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
124
-
* In doc/conf.py
139
+
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
140
+
141
+
* In doc/conf.py
125
142
126
-
- update version and release to the *next* milestone
143
+
- update version and release to the *next* milestone
0 commit comments