File tree Expand file tree Collapse file tree 1 file changed +13
-3
lines changed Expand file tree Collapse file tree 1 file changed +13
-3
lines changed Original file line number Diff line number Diff line change @@ -145,11 +145,21 @@ is shown in **bold** in the index. When updating the index, please make sure
145145to update the display accordingly by removing the bold styling from the previous
146146release.
147147
148+ #### Step 3: Update any REPLACEME tags in the docs
149+
150+ If this release includes new APIs then it is necessary to document that they
151+ were first added in this version. The relevant commits should already include
152+ ` REPLACEME ` tags as per the example in the
153+ [ docs README] ( ../tools/doc/README.md ) . Check for these tags with
154+ ` grep REPLACEME doc/api/*.md ` , and substitute this node version with
155+ ` sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md ` or
156+ ` perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md ` .
157+
148158### 4. Create Release Commit
149159
150- The ` CHANGELOG.md ` , ` doc/changelogs/CHANGELOG_*.md ` , and ` src/node_version.h `
151- changes should be the final commit that will be tagged for the release. When
152- committing these to git, use the following message format:
160+ The ` CHANGELOG.md ` , ` doc/changelogs/CHANGELOG_*.md ` , ` src/node_version.h ` , and
161+ ` REPLACEME ` changes should be the final commit that will be tagged for the
162+ release. When committing these to git, use the following message format:
153163
154164```
155165YYYY-MM-DD, Version x.y.z (Release Type)
You can’t perform that action at this time.
0 commit comments