GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc,crypto: update webcrypto docs for global access by panva · Pull Request #44723 · nodejs/node

Conversation

@panva

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bricss reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@panva
doc,crypto: update webcrypto docs for global access
bbb8c13
@panva panva added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to Node.js documentation. semver-major PRs that contain breaking changes and should be released in the next major version. webcrypto Issues and PRs related to the Web Crypto API. labels Sep 19, 2022
@panva
panva requested a review from aduh95 September 19, 2022 10:04
@panva

panva commented Sep 19, 2022

Copy link
Copy Markdown
Member Author

cc @nodejs/crypto
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
aduh95
aduh95 reviewed Sep 19, 2022
View reviewed changes

@aduh95 aduh95 left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread doc/api/webcrypto.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread doc/api/webcrypto.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
@aduh95 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

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@panva

panva commented Sep 19, 2022

Copy link
Copy Markdown
Member Author

This label setup works too tho.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@panva @aduh95
Update doc/api/webcrypto.md
52bba36 
Co-authored-by: Antoine du Hamel <[email protected]>
@panva panva added the commit-queue-squash PRs the Commit Queue should land as one squashed commit. label Sep 19, 2022
aduh95
aduh95 approved these changes Sep 19, 2022
View reviewed changes
@aduh95 aduh95 added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Sep 19, 2022
@aduh95

aduh95 commented Sep 19, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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.
panva and tniessen reacted with thumbs up emoji panva reacted with heart emoji
All reactions
  • 👍 2 reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
tniessen
tniessen approved these changes Sep 19, 2022
View reviewed changes

@tniessen tniessen left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread doc/api/webcrypto.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
@panva @tniessen
Update doc/api/webcrypto.md
a4dbe08 
Co-authored-by: Tobias Nießen <[email protected]>
tniessen
tniessen approved these changes Sep 19, 2022
View reviewed changes
lpinca
lpinca approved these changes Sep 19, 2022
View reviewed changes
@panva panva added the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 21, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 21, 2022
@nodejs-github-bot
nodejs-github-bot merged commit 46dcfb3 into nodejs:main Sep 21, 2022
@nodejs-github-bot

nodejs-github-bot commented Sep 21, 2022

Copy link
Copy Markdown
Collaborator

Landed in 46dcfb3
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@panva
panva deleted the webcrypto-global-docs branch October 13, 2022 09:12
@RafaelGSS RafaelGSS mentioned this pull request Oct 14, 2022
2022-10-18, Version 19.0.0 (Current) #44626
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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-squash PRs the Commit Queue should land as one squashed commit. crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to Node.js documentation. webcrypto Issues and PRs related to the Web Crypto API.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@panva @aduh95 @nodejs-github-bot @lpinca @tniessen
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.