doc: add commit formats for release blog posts #8631
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
cjihrig
reviewed
Sep 17, 2016
| * 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.
For consistency with the rest of this doc, can you replace <VERSION> with vx.y.z.
There was a problem hiding this comment.
In core, the subsystem is lowercase. Should we make this lowercase as well?
There was a problem hiding this comment.
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.
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.
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 |
cjihrig
approved these changes
Sep 17, 2016
MylesBorins
suggested changes
Sep 18, 2016
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 |
MylesBorins
approved these changes
Sep 19, 2016
jasnell
reviewed
Sep 20, 2016
| @@ -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.
Perhaps this should clarify that opening and merging PR's that are specific to releases is fine?
There was a problem hiding this comment.
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 |
MylesBorins
pushed a commit
that referenced
this pull request
Sep 27, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
landed in 23e1ed7 Thanks for the contribution @fene |
ghost
deleted the
|
🎉 |
|
sorry @fene I didn't see this when I pushed through my announcements, will try remember for next time! |
jasnell
pushed a commit
that referenced
this pull request
Sep 29, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Sep 30, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 10, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Fishrock123
pushed a commit
that referenced
this pull request
Oct 11, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
rvagg
pushed a commit
that referenced
this pull request
Oct 18, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 26, 2016
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 <cjihrig@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@keybase.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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