Skip to content
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

Include link to blog post in security-release email #38143

Closed
WaleedAshraf opened this issue Apr 7, 2021 · 8 comments
Closed

Include link to blog post in security-release email #38143

WaleedAshraf opened this issue Apr 7, 2021 · 8 comments
Labels
meta Issues and PRs related to the general management of the project.

Comments

@WaleedAshraf
Copy link
Contributor

The recent security release email for 6-Apr-2021 had two broken links for the versions.

Broken:

Correct:

Link for v15.14.0 was fixed by @Trott later here: nodejs/nodejs.org#3794
For v12.22.1, seems it was a typo in the email. The blog post had the correct link.

Suggestion:

There was no link to the actual blog post (https://nodejs.org/en/blog/vulnerability/april-2021-security-releases/) in the email. So, there was no way to navigate to the updated version from the email.

Would it be better if we don't include links to the individual versions in the email, rather include link to the blog post. In that case, the blog post can be fixed and stays up to date.

cc @nodejs/security-release

@nschonni
Copy link
Member

nschonni commented Apr 7, 2021

Don't think this is the right repo. There is nothing here that sends out any emails. If you're talking about general GitHub notifications, that's not something we have control over

@richardlau
Copy link
Member

This is referring to the emails sent to the mailing list (https://groups.google.com/group/nodejs-sec) as per the security release process. I'll move this over to core because that's where the process doc lives.

@richardlau richardlau transferred this issue from nodejs/nodejs.org Apr 8, 2021
@richardlau richardlau added the meta Issues and PRs related to the general management of the project. label Apr 8, 2021
@richardlau
Copy link
Member

cc @danbev @mhdawson as the most recent people to have run through this process for their thoughts on the suggestion.

@danbev
Copy link
Contributor

danbev commented Apr 8, 2021

I've replied with a message to the group: https://groups.google.com/u/1/g/nodejs-sec/c/TXKhlMr55UA, and provided a like to the blog post as well.

Would it be better if we don't include links to the individual versions in the email, rather include link to the blog post

I think we could do that or we could include a link to the blog post in addition to the copied information.

@WaleedAshraf
Copy link
Contributor Author

@danbev Thanks for the correction email. Would have been better if you also included the correct link for v12. But it's fine, as the link to the blog is also included.

I'm not sure if there's a template for these emails which we can update to always include a link to the blog. If the release/security team thinks it'd be good to include.

@mhdawson
Copy link
Member

mhdawson commented Apr 8, 2021

I think reducing to a single source of truth makes sense to me. The messages to the nodejs-sec mailing list could then just include the link to the blog post, and possibly the "Contact and future updates" section.

One thing I failed to notice earlier (my bad for not catching in review is that the lastest updates to the blog post did not keep the initial announce at the bottom. An example were we did that is: https://nodejs.org/en/blog/vulnerability/november-2020-security-releases/. I think if we do that for future ones, then having a reference in the email versus duplicated content will provide the same info, as well as making it easier for the security release steward.

@danbev does that make sense to you?

@danbev
Copy link
Contributor

danbev commented Apr 9, 2021

Yeah, that makes sense to just have a link to the blog post and also save the pre-announcement in the real announcement 👍
I'll update the security release process doc with this.

danbev added a commit to danbev/node that referenced this issue Apr 19, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

Refs: nodejs#38143
danbev added a commit to danbev/node that referenced this issue Apr 19, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

Refs: nodejs#38143
danbev added a commit that referenced this issue Apr 23, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

PR-URL: #38290
Refs: #38143
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue Apr 29, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

PR-URL: #38290
Refs: #38143
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue May 30, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

PR-URL: #38290
Refs: #38143
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue Jun 5, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

PR-URL: #38290
Refs: #38143
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue Jun 11, 2021
This commit adds a suggestion for a template to be used as part of the
security release process. One step of this process is to create an email
to nodejs-sec group and currently would contain a copy and pasted
version of what is published on nodejs.org. This suggestion is to
instead use a link to the blog post.

PR-URL: #38290
Refs: #38143
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@richardlau
Copy link
Member

The email template in the security release process guide was updated in #38290 and recent emails, e.g. https://groups.google.com/g/nodejs-sec/c/xIj1bpCtY3I, contain links to the relevant blog post.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

No branches or pull requests

5 participants