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,crypto: update webcrypto docs for global access #44723

Merged
merged 3 commits into from Sep 21, 2022
Merged

doc,crypto: update webcrypto docs for global access #44723

merged 3 commits into from Sep 21, 2022

Conversation

panva
Copy link
Member

@panva panva commented Sep 19, 2022

Follow up to semver-major PRs that contain breaking changes and should be released in the next major version. #42083 this updates the docs to reflect the standard global access to the module and its APIs.

@panva panva added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. semver-major PRs that contain breaking changes and should be released in the next major version. webcrypto labels Sep 19, 2022
@panva panva requested a review from aduh95 September 19, 2022 10:04
@panva
Copy link
Member Author

panva commented Sep 19, 2022

cc @nodejs/crypto

aduh95
aduh95 reviewed Sep 19, 2022
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

This is not semver-major, as it only changes the docs.

doc/api/webcrypto.md Show resolved Hide resolved
doc/api/webcrypto.md Outdated Show resolved Hide resolved
@aduh95 aduh95 added dont-land-on-v14.x dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels Sep 19, 2022
@panva
Copy link
Member Author

panva commented Sep 19, 2022

It is major because it depends on a major change. Currently global access is not enabled by default.

@panva
Copy link
Member Author

panva commented Sep 19, 2022

This label setup works too tho.

@panva @aduh95
Update doc/api/webcrypto.md
52bba36 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@panva panva added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Sep 19, 2022
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 19, 2022
@aduh95
Copy link
Contributor

aduh95 commented Sep 19, 2022 •
edited

It is major because it depends on a major change. Currently global access is not enabled by default.
This label setup works too tho.

semver-major PRs that contain breaking changes and should be released in the next major version. PRs require two approvals from TSC, and appear in the notable changes section of the changelog by default. Using dont-land labels avoid both issues, and is more appropriate in this case IMO.

tniessen
tniessen approved these changes Sep 19, 2022
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

I'd prefer if node:crypto.webcrypto remained documented, especially because globalThis.crypto won't work in current release lines. One suggestion below.

doc/api/webcrypto.md Outdated Show resolved Hide resolved
@panva @tniessen
Update doc/api/webcrypto.md
a4dbe08 
Co-authored-by: Tobias Nießen <tniessen@tnie.de>
@panva panva added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 21, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 21, 2022
@nodejs-github-bot nodejs-github-bot merged commit 46dcfb3 into nodejs:main Sep 21, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 46dcfb3

@panva panva deleted the webcrypto-global-docs branch October 13, 2022 09:12
@RafaelGSS RafaelGSS mentioned this pull request Oct 14, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@tniessen tniessen tniessen approved these changes

@aduh95 aduh95 aduh95 approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. webcrypto
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@panva @aduh95 @nodejs-github-bot @lpinca @tniessen