[DOCS] improve trusted publishing docs for easier github ci migration
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 10.1k
- Forks
- 4.7k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
Is there an existing issue for this?
- I have searched the existing issues
This is a CLI Docs Enhancement, not another kind of Docs Enhancement.
- This is a CLI Docs Enhancement.
Description of Problem
I wasted a lot of time on migrating my github action (for npm publish) to trusted publishing due to gaps in trusted publishing docs and the bug #8730
This was the exact issue and the solution - https://github.com/gitcommitshow/resilient-llm/issues/39
Potential Solution
Following improvements can save time and frustration for others
- Add the node v24 as mandatory requirement in the github action. Could not discover this until I saw comments on #8730
- Highlight where to find the trusted publishing, include visual guide. I had hard time finding this.
- A clear destination to report issues. I could not find this info on the docs. I tried "contact npm" on the footer and waited for a day to get an answer. Then only I searched github for similar issue and could discover this page.
Docs URL
https://docs.npmjs.com/trusted-publishers#github-actions-configuration
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the trusted-publishers GitHub Actions configuration page at docs.npmjs.com/trusted-publishers#github-actions-configuration. Review the migration steps and identify where the Node v24 requirement, a visual guide to locating trusted publishing, and a clear issue-reporting destination should be documented. Done means the page addresses all three reported gaps and lets a GitHub Actions user find help without searching elsewhere.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, javascript, nodejs
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100