Skip to content

Commit 99e0f14

Browse files
danielleadamsruyadorno
authored andcommitted
doc: add format-md step to release guide
PR-URL: #41809 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 62f2c07 commit 99e0f14

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/contributing/releases.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,9 @@ of the list. The most recent release for each release line is shown in **bold**
312312
in the index. When updating the index, please make sure to update the display
313313
accordingly by removing the bold styling from the previous release.
314314

315+
Run `make format-md` to ensure the `CHANGELOG_Vx.md` and `CHANGELOG.md` files
316+
are formatted correctly.
317+
315318
#### Step 3: Update any REPLACEME and DEP00XX tags in the docs
316319

317320
If this release includes new APIs then it is necessary to document that they

0 commit comments

Comments
 (0)