[Bug] README is not correctly shown on verdaccio using `yarn npm publish`
Open
Nobody has claimed this yet.
bug
external bug
upholded
- Dominant language
- TypeScript
- Stars
- 8.1k
- Forks
- 1.3k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
README is not correctly shown on self-hosted verdaccio using yarn npm publish.
To Reproduce
(require docker to launch verdaccio so as to reproduce)
Reproduction
mkdir yarn-verdaccio-readme
cd yarn-verdaccio-readme
yarn set version berry
echo '
npmPublishRegistry: http://localhost:4873
unsafeHttpWhitelist: [localhost]
' >> .yarnrc.yml
echo '
{
"name": "yarn-verdaccio-readme",
"version": "0.1.0"
}
' > package.json
echo '# yarn-verdaccio-readme' > README.md
yarn
docker run --rm -p 4873:4873 -d verdaccio/verdaccio:4.8.1
echo 'input some random username/password'
yarn npm login --publish
yarn npm publish
echo 'open http://localhost:4873/-/web/detail/yarn-verdaccio-readme then you will see "ERROR: No README data found!".'
Screenshots
$ yarn npm publish
➤ YN0000: README.md
➤ YN0000: package.json
➤ YN0000: Package archive published
➤ YN0000: Done in 0.91s
Environment
- Yarn version 2.1.1
Additional context
README.mdis uploaded correctly.- No issue with
npm publish.
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 yarn npm publish entry point and reproduce the package publication using the provided Docker Verdaccio setup. Confirm that the uploaded README is rendered in Verdaccio, matching the expected behavior described in the report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, nodejs
- Domain
- release
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100