Skip to content

Add Trusted Publisher (OIDC) documentation for npm - #2

Open
chiranjib-swain wants to merge 7 commits into
mainfrom
feature/add-oidc-trusted-publish-docs
Open

Add Trusted Publisher (OIDC) documentation for npm#2
chiranjib-swain wants to merge 7 commits into
mainfrom
feature/add-oidc-trusted-publish-docs

Conversation

@chiranjib-swain

@chiranjib-swain chiranjib-swain commented Apr 21, 2026

Copy link
Copy Markdown
Owner

Description:
This pull request adds comprehensive documentation for publishing npm packages using Trusted Publisher (OIDC) authentication, improving the guidance for secure and modern publishing workflows in CI/CD environments. The most significant changes are grouped below.

Documentation enhancements for npm Trusted Publisher (OIDC):

  • Added a new section in docs/advanced-usage.md detailing how to publish to npm using Trusted Publisher (OIDC), including requirements, example workflows and references.
  • Updated the README.md table of contents to include a link to the new documentation section for publishing to npm with Trusted Publisher (OIDC).

Related issue:
Add link to the related issue.

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation to this repository’s advanced usage guide for publishing npm packages via npm Trusted Publishers (OIDC) from GitHub Actions, and links to that new section from the README’s advanced-usage TOC.

Changes:

  • Added a new “Publishing to npm with Trusted Publisher (OIDC)” section to docs/advanced-usage.md (requirements, example workflow, notes, limitations, FAQ, troubleshooting, references).
  • Updated README.md advanced-usage TOC to link to the new section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/advanced-usage.md Adds a new OIDC/trusted publishing documentation section, including workflow examples and troubleshooting guidance.
README.md Adds a TOC entry linking to the new advanced-usage documentation section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/advanced-usage.md Outdated
Comment thread docs/advanced-usage.md Outdated
Comment thread docs/advanced-usage.md Outdated
Comment thread docs/advanced-usage.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants