FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,crypto: update webcrypto docs for global access by panva · Pull Request #44723 · nodejs/node · GitHub

/ node Public

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

Merged
nodejs-github-bot merged 3 commits into
nodejs:mainfrom
panva:webcrypto-global-docs
Sep 21, 2022
ConversationCommits (3)ChecksFiles changed
Merged

doc,crypto: update webcrypto docs for global access#44723
nodejs-github-bot merged 3 commits into
nodejs:mainfrom
panva:webcrypto-global-docs

Conversation

panva commented Sep 19, 2022

Copy link
Copy Markdown
Member

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 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 requested a review from aduh95 September 19, 2022 10:04

panva commented Sep 19, 2022

Copy link
Copy Markdown
Member Author

cc @nodejs/crypto

aduh95 reviewed Sep 19, 2022
View reviewed changes

aduh95 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread doc/api/webcrypto.md
Comment thread doc/api/webcrypto.md Outdated
aduh95 added dont-land-on-v14.x and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels Sep 19, 2022

panva commented Sep 19, 2022

Copy link
Copy Markdown
Member Author

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

panva commented Sep 19, 2022

Copy link
Copy Markdown
Member Author

This label setup works too tho.

Update doc/api/webcrypto.md
52bba36 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
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 added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Sep 19, 2022

aduh95 commented Sep 19, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

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 approved these changes Sep 19, 2022
View reviewed changes

tniessen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread doc/api/webcrypto.md Outdated
Update doc/api/webcrypto.md
a4dbe08 
Co-authored-by: Tobias Nießen <tniessen@tnie.de>
panva added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 21, 2022
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 merged commit 46dcfb3 into nodejs:main Sep 21, 2022

nodejs-github-bot commented Sep 21, 2022

Copy link
Copy Markdown
Collaborator

Landed in 46dcfb3

panva deleted the webcrypto-global-docs branch October 13, 2022 09:12
RafaelGSS mentioned this pull request Oct 14, 2022
Merged
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes
tniessen tniessen approved these changes
aduh95 aduh95 approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, 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. webcrypto

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL