Skip to content

Add documentation for trusted publishers #1674

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.

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

Merged
merged 4 commits into from
Jul 31, 2025
Merged

Add documentation for trusted publishers #1674

merged 4 commits into from
Jul 31, 2025

Conversation

leobalter
Copy link
Contributor

This adds new documentation for trusted publishers, to be released soon.

References

Related to npm/cli#8336
Replaces #1673 (now using a branch without a fork)

@leobalter leobalter self-assigned this Jul 17, 2025
@leobalter leobalter requested a review from a team as a code owner July 17, 2025 01:04
@leobalter leobalter added the docs label Jul 17, 2025
@leobalter
Copy link
Contributor Author

I rebased the commits into a single one.

Copy link
Member

@steiza steiza 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 great! One minor nit.

Copy link

@nishantms nishantms left a comment

Choose a reason for hiding this comment

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

🎉

@leobalter
Copy link
Contributor Author

I rebased the branch - squashing the previous commits into 3abe6fb - and added a little change to replace minimun cli version required for oidc from 11.5.0 to 11.5.1 here: 95c4ece

@leobalter leobalter merged commit 78e78d6 into main Jul 31, 2025
9 checks passed
@leobalter leobalter deleted the oidc branch July 31, 2025 15:36
leobalter pushed a commit that referenced this pull request Aug 4, 2025
<!-- What / Why -->
<!-- Describe the request in detail. What it does and why it's being
changed. -->

The internal links added in
#1674 followed the on-disk
paths and did not respect that the URL paths use a different scheme, as
explained in
https://github.com/npm/documentation/blob/4c574b89e23515d8411e5ec52624d6a932b874e0/CONTRIBUTING.md#urls:

> ### URLs
> Note that for backward compatibility reasons, the on-disk paths are
not precisely identical to the URLs for the documentation. To keep URLs
expressive but still short, intermediate directories are removed from a
page's URL.
>
> (...)
>
> You might (understandably) expect the page "Creating Node.js modules"
to be URL-wise beneath `contributing-packages-to-the-registry`, but
unfortunately, you would be wrong. To keep URLs short, the intermediate
folder paths are removed from pages, so "Creating Node.js modules"
becomes `https://docs.npmjs.com/creating-node-js-modules`.

Also see
https://github.com/npm/documentation/blob/4c574b89e23515d8411e5ec52624d6a932b874e0/CONTENT-MODEL.md#content-structure:

> ## Content structure
> 
> Docs are grouped by topic.
> 
> - Top-level doc set (Example:
https://docs.npmjs.com/packages-and-modules)
> - Categories (Example:
https://docs.npmjs.com/packages-and-modules/introduction-to-packages-and-modules)
> - **Articles (Example:
https://docs.npmjs.com/about-packages-and-modules)**

As a result, these links did not work at https://docs.npmjs.com/. This
PR fixes them.

## References

Related to #1674 (all links
fixed in this PR were introduced there)

<!-- Examples:
  Related to #0
  Depends on #0
  Blocked by #0
  Fixes #0
  Closes #0
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants