Skip to content

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
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

@panvapanva commented Sep 19, 2022

Copy link
Copy Markdown
Member

Follow up to semver-majorPRs 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.

@panvapanva 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 aduh95September 19, 2022 10:04
@panva

panva commented Sep 19, 2022

Copy link
Copy Markdown
MemberAuthor

cc @nodejs/crypto

aduh95
aduh95 reviewed Sep 19, 2022
View reviewed changes

@aduh95aduh95 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.

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

Comment threaddoc/api/webcrypto.md
Comment threaddoc/api/webcrypto.md Outdated
@aduh95aduh95 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

panva commented Sep 19, 2022

Copy link
Copy Markdown
MemberAuthor

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

@panva

panva commented Sep 19, 2022

Copy link
Copy Markdown
MemberAuthor

This label setup works too tho.

@panva@aduh95
Update doc/api/webcrypto.md
52bba36
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@panvapanva 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
@aduh95aduh95 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

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-majorPRs 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

@tniessentniessen 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.

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

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

nodejs-github-bot commented Sep 21, 2022

Copy link
Copy Markdown
Collaborator

Landed in 46dcfb3

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

Reviewers

@lpincalpincalpinca approved these changes
@tniessentniessentniessen approved these changes
@aduh95aduh95aduh95 approved these changes

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.cryptoIssues and PRs related to the crypto subsystem.docIssues 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

@panva@aduh95@nodejs-github-bot@lpinca@tniessen