doc: updating REPLACEME tag during release #7514
Conversation
|
@claudiorodriguez I wasn't sure what to add to CONTRIBUTING.md, it's quite a short document at the moment (which is a good thing IMO), and I guess people adding new APIs are probably already familiar with the contribution process. |
gibfahn
force-pushed
the
pr-replaceme-doc
branch
2 times, most recently
from
49378a2
to
f5c2bc8
Compare
|
Can we limit to 80 columns? Also, I believe the |
| @@ -145,9 +145,13 @@ is shown in **bold** in the index. When updating the index, please make sure | |||
| to update the display accordingly by removing the bold styling from the previous | |||
| release. | |||
|
|
|||
| #### Step 3: Update any REPLACEME tags in the docs | |||
|
|
|||
| If this release includes new APIs then we need to document that they were first added in this version. The relevant commits should already include REPLACEME tags as per the example in the [docs README](../tools/doc/README.md). Check for these tags with `grep REPLACEME doc/api/*.md`, and substitute this node version with `sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`. | |||
There was a problem hiding this comment.
For new additions to the doc, it would be preferred to avoid uses of words like we, you, etc. For instance, the first sentence can be reworded as "If this release includes new APIs, then it is necessary to document that those were first added in this version."
Add a paragraph to the releases.md guide to document replacing the REPLACEME tag with the release version for new APIs.
|
@jasnell Done, thanks. @evanlucas Should be 80 columns now. As for the sed problem, it seems that the OSX version is incompatible with the standard GNU version. Judging from these (one, two) Stack Overflow answers, it looks like the easiest method is to use the perl command instead (perl should be installed by default), or Perl command: |
|
LGTM if the release folks are happy, and I have made the experience that cross-platform |
|
LGTM |
|
LTGM |
|
@thealphanerd can you review/comment as a "release folk" |
|
LGTM |
Add a paragraph to the releases.md guide to document replacing the REPLACEME tag with the release version for new APIs. PR-URL: #7514 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]>
|
Landed in b10ee9d |
|
yikes .. you know this is going to get forgotten regularly and will require follow-up PRs to address it. Perhaps it's time to start scripting some of the release stuff, bumping version, ABI #, signed tagging, maybe even have something prompt with a checklist you have to answer to push a release out, it's getting kind of complicated. |
|
@nodejs/release note the new requirement for releases added in here |
|
nope, obviously in my backlog that I haven't got to yet! thanks @addaleax, that should help |
Add a paragraph to the releases.md guide to document replacing the REPLACEME tag with the release version for new APIs. PR-URL: #7514 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]>
Checklist
Affected core subsystem(s)
doc
Description of change
Add a paragraph to the releases.md guide to document replacing the
REPLACEME tag with the release version for new APIs.
Ref: #6864 (comment), #6578
@addaleax @claudiorodriguez @evanlucas