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.

Sign up for GitHub

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

Jump to bottom

doc: add check for security reverts #51376

Closed
wants to merge 3 commits into from
Closed

doc: add check for security reverts #51376

wants to merge 3 commits into from

Conversation

mhdawson
Copy link
Member

@mhdawson mhdawson commented Jan 4, 2024

  • Add step to check that any PRs with breaking changes have command line options to revert
  • Add info on how to easily add command line option to revert a breaking change related to a CVE

@mhdawson
doc: add check for security reverts
d1c2716 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 4, 2024
bnb
bnb reviewed Jan 5, 2024
View reviewed changes
doc/contributing/security-release-process.md Outdated
Comment on lines 230 to 236
Breaking changes are allowed in existing LTS lines in order to fix
important security vulnerabilities. When breaking changes are made
it is important to provide a command line option that restores
the original behaviour.

Node.js includes the command line option `--security-revert` and
has the boilerplate to make additions easy.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This starts by talking about LTS lines, but then switches context to Node.js includes. Upon first read, I assumed that this flag would only be included in LTS versions, missing the context switch. I'd recommend adding more, direct language about where and when this feature is available.

mhdawson and others added 2 commits January 5, 2024 09:38
@mhdawson @aduh95
Update doc/contributing/security-release-process.md
0ac0754 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@mhdawson
address comments
6d54240
mhdawson added a commit that referenced this pull request Jan 8, 2024
@mhdawson
doc: add check for security reverts
718e4e6 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #51376
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@mhdawson
Copy link
Member Author

mhdawson commented Jan 8, 2024

Landed in 718e4e6

@mhdawson mhdawson closed this Jan 8, 2024
marco-ippolito pushed a commit to marco-ippolito/node that referenced this pull request Jan 12, 2024
@mhdawson @marco-ippolito
doc: add check for security reverts
ea10bee 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: nodejs#51376
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Medhansh404 pushed a commit to Medhansh404/node that referenced this pull request Jan 19, 2024
@mhdawson @Medhansh404
doc: add check for security reverts
6bb3074 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: nodejs#51376
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
targos pushed a commit that referenced this pull request Feb 15, 2024
@mhdawson @targos
doc: add check for security reverts
70e88cf 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #51376
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@marco-ippolito marco-ippolito mentioned this pull request Mar 1, 2024
Merged
richardlau pushed a commit that referenced this pull request Mar 25, 2024
@mhdawson @richardlau
doc: add check for security reverts
2de1c85 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #51376
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
richardlau pushed a commit that referenced this pull request Mar 25, 2024
@mhdawson @richardlau
doc: add check for security reverts
a09f440 
- Add step to check that any PRs with breaking changes
  have command line options to revert
- Add info on how to easily add command line option
  to revert a breaking change related to a CVE

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #51376
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@richardlau richardlau mentioned this pull request Mar 25, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 approved these changes

@bnb bnb bnb left review comments

@RafaelGSS RafaelGSS RafaelGSS approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

@tniessen tniessen tniessen approved these changes

@lpinca lpinca lpinca approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@mhdawson @nodejs-github-bot @bnb @lpinca @tniessen @gireeshpunathil @aduh95 @RafaelGSS