Skip to content

Commit e9ec56a

Browse files
committed
docs(releasing): add instructions to maintain experimental feature docs
1 parent 05d1489 commit e9ec56a

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

etc/notes/releasing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ The MongoDB driver can now generate a cup of joe.
7676

7777
1. On slack notify `#node-driver-docs`, `#nodejs-devtools`, and `#mongoose` that we intend to publish a release.
7878
- You may skip this step if you are releasing a package other than the driver.
79+
1. **If there are new or changed experimental features**, update `EXPERIMENTAL_FEATURES.md`
80+
- Update the version number in the document header
81+
- Update the count of experimental annotations (grep for `@experimental` in `src/`)
82+
- Add descriptions for any new `@experimental` features
83+
- Remove or update entries for features that are no longer experimental
84+
- Ensure all source file references omit line numbers (links should point to files, not specific lines)
85+
- Commit and push these changes to the release branch before running release notes
7986
1. Comment "`run release_notes`" on the release PR.
8087
- This will kick off the action that reads the notes from each PR going into the release.
8188
- Double check the result looks logically organized

0 commit comments

Comments
 (0)