-
Notifications
You must be signed in to change notification settings - Fork 29.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add commit formats for release blog posts #8631
Conversation
A few tiny nits, but this LGTM. Hopefully it will help the website working group as well. |
@cjihrig please do point out the nits :o |
See the comments I left. |
hmm, i don't see any comments... weird |
* Always use pull-requests on the nodejs.org repo. Be respectful of that working group, but you shouldn't have to wait for PR sign-off. Opening a PR and merging it immediately _should_ be fine. | ||
* Always use pull-requests on the nodejs.org repo. Be respectful of that working group, but you shouldn't have to wait for PR sign-off. Opening a PR and merging it immediately _should_ be fine. However, please follow the following format for commit titles/descriptions: | ||
``` | ||
Blog: <VERSION> release post |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the rest of this doc, can you replace <VERSION>
with vx.y.z
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In core, the subsystem is lowercase. Should we make this lowercase as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also think that it would be better to use lowercased prefixes. There are already some commits that have the blog:
prefix and it will create some kind of consistency with the core repo.
``` | ||
Blog: <VERSION> release post | ||
|
||
Refs: <LINK TO ORIGINAL RELEAST PULL REQUEST IN nodejs/node> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly <full URL to your release proposal PR>
here.
@@ -294,7 +294,12 @@ Create a new blog post by running the [nodejs.org release-post.js script](https: | |||
* You can add a short blurb just under the main heading if you want to say something important, otherwise the text should be publication ready. | |||
* The links to the download files won't be complete unless you waited for the ARMv6 builds. Any downloads that are missing will have `*Coming soon*` next to them. It's your responsibility to manually update these later when you have the outstanding builds. | |||
* The SHASUMS256.txt.asc content is at the bottom of the post. When you update the list of tarballs you'll need to copy/paste the new contents of this file to reflect those changes. | |||
* Always use pull-requests on the nodejs.org repo. Be respectful of that working group, but you shouldn't have to wait for PR sign-off. Opening a PR and merging it immediately _should_ be fine. | |||
* Always use pull-requests on the nodejs.org repo. Be respectful of that working group, but you shouldn't have to wait for PR sign-off. Opening a PR and merging it immediately _should_ be fine. However, please follow the following format for commit titles/descriptions: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
format for commit titles/descriptions
-> commit message format
Oops, I guess I didn't submit my review. Do you see them now? |
@cjihrig yes! |
nits should be fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM if other members of @nodejs/release are ok with it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything is looking good. Can you please squash all commits
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository refs: #8629
@thealphanerd squashed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -294,7 +294,12 @@ Create a new blog post by running the [nodejs.org release-post.js script](https: | |||
* You can add a short blurb just under the main heading if you want to say something important, otherwise the text should be publication ready. | |||
* The links to the download files won't be complete unless you waited for the ARMv6 builds. Any downloads that are missing will have `*Coming soon*` next to them. It's your responsibility to manually update these later when you have the outstanding builds. | |||
* The SHASUMS256.txt.asc content is at the bottom of the post. When you update the list of tarballs you'll need to copy/paste the new contents of this file to reflect those changes. | |||
* Always use pull-requests on the nodejs.org repo. Be respectful of that working group, but you shouldn't have to wait for PR sign-off. Opening a PR and merging it immediately _should_ be fine. | |||
* Always use pull-requests on the nodejs.org repo. Be respectful of that working group, but you shouldn't have to wait for PR sign-off. Opening a PR and merging it immediately _should_ be fine. However, please follow the following commit message format: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps this should clarify that opening and merging PR's that are specific to releases is fine?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doesn't this sort of arise from the context of this document/paragraph?
LGTM. Going to land the current content, if there are more tweaks that can come in another PR |
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
landed in 23e1ed7 Thanks for the contribution @fene |
🎉 |
sorry @fene I didn't see this when I pushed through my announcements, will try remember for next time! |
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
this commit enhances the guidelines to creating a release blog post, specifically by adding a commit format that must be adhered to when creating a pull request on the website repository Fixes: #8629 PR-URL: #8631 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
Checklist
make -j4 test
(UNIX), orvcbuild test nosign
(Windows) passesAffected core subsystem(s)
doc
Description of change
this commit enhances the guidelines to creating a release blog post, specifically by adding
a commit format that must be adhered to when creating a pull request on the website repository
refs: #8629
/cc @thealphanerd