build: add REPLACEME tag for version info in docs #6864
Conversation
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: nodejs#6578
addaleax
added
doc
|
If you go through the trouble of filing the pull request, you can claim authorship. :-) LGTM either way. |
|
Credit where credit is due, I’m going to leave it like that. ;) |
|
LGTM, should any doc be updated mentioning this? |
|
@claudiorodriguez Hmm… got any suggestions? It might be nice to make collaborators aware of this in some way, yes. |
|
@addaleax right now the |
Can you leave my LGTM out in that case? Otherwise I'd show up as both author and reviewer. |
|
@bnoordhuis Of course, yep. @claudiorodriguez I’ve added it here… that should be okay. Still LGTY? |
|
So, I think it was @Fishrock123 that brought it up, but we should always know that a new feature or method will be going in in the next minor right? Is this still necessary? |
|
@evanlucas I don’t have strong feelings about it… basically, in my head it’s like this: Pro
Contra
You @nodejs/release people can probably assess things better and if you prefer not to do it this way, that’s perfectly fine. |
|
There are definitely pros to this approach. My biggest concern with going this route is how do we make the update permanent? Is that something the releaser should commit and push back up? Otherwise, when we hit the next release, the |
|
Would it be okay to do something like this together with/in the release commit? If I’ve understood everything correctly, that one is landed both in the version-specific branch and master. |
|
That could work. We do cherry pick the release commit from the release proposal branch back to master. So this will probably work fine for v6, but may become a little hairy for v4. I'm honestly not sure. I do think I'm +1 on this, but really think that all of @nodejs/release should see this before landing. Also, if we add this, we need to make sure that the |
|
Yeah, there’s no hurry to implement this process in any case. And regarding v4.x in general, so far this feature isn’t even implemented there, but I think I’ll do a backporting PR once we’re pretty much through with #6578. |
|
@addaleax yep, LGTM on the PR itself. Agree on waiting on more feedback from the release team before landing though |
|
I don't really mind, but I have a question on how this will impact the release process commits-wise... Currently we do two commits, both of which are the only un-signed-off commits people are regularly allowed to do. (Some leeway is given for if releasers mess up and have to fix links or something afterwards.) Does this mean we add a third commit before? e.g:
Or do we just roll this into the Changelog commit? |
|
I don't see anything wrong with rolling it into the Changelog commit. |
|
Anybody from @nodejs/release want to give their thumbs up for this? :) |
|
+1 to rolling it into the Changelog commit. And LGTM |
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: #6578 PR-URL: #6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: #6578 PR-URL: #6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: #6578 PR-URL: #6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: #6578 PR-URL: #6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: nodejs#6578 PR-URL: nodejs#6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: nodejs#6578 PR-URL: nodejs#6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: #6578 PR-URL: #6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: #6578 PR-URL: #6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: #6578 PR-URL: #6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: #6578 PR-URL: #6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: #6578 PR-URL: #6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: #6578 PR-URL: #6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Ref: #6578 PR-URL: #6864 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: #6578 PR-URL: #6864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Checklist
Affected core subsystem(s)
build
Description of change
Add a
REPLACEMEtag that should be used when introducing docs for new features, so that they can be updated when releases are made. Example usage:Ref: #6578
@bnoordhuis This is taken straight from #6578 (comment) so I’ve set the commit author to you. I guess that’s okay with you?