[Bug] README.md is not published to npm

[Deadarius]

When I try lerna publish - npm registry doesn't display readme, however when I use npm publish - it does.

[jamiebuilds]

The README where? Individual packages should have their own README, the primary one at the root of the repo will not be published anywhere.

[gigabo]

We're actually seeing the same thing. Assumed we were doing something wrong. Hadn't considered that it may be related to deploying with lerna.

Here's our package and here's the corresponding npm page with missing README.

[jamiebuilds]

Weird... we're literally just cd-ing into the directory and running npm publish

[gigabo]

Maybe something to do with the package not living at the repo root?

Seems more likely to be an npm bug than a lerna bug, honestly.

[Deadarius]

Yes, I do have readmes... When I was trying to find a problem I noticed that you just run existing npm... have no idea what can be a problem here. Only aware of this issue in outdated version of npm.

[Deadarius]

@gigabo But it works fine when I run npm publish directly...

[ianwremmel]

I seem to be running into the same issue. I definitely have a new README, but the changes aren't showing up on NPM.

[ianwremmel]

(by NPM, I mean https://www.npmjs.com/)

[ianwremmel]

I have a hypothesis that the way lerna messes with dist-tags isn't triggering npm's normal website refresh job. I've opened a support ticket with npm, inc to investigate and will report back here if I hear anything.

[Deadarius]

@ianwremmel thank you very much, I still suffer from this issue.

[jamiebuilds]

This bug is hard to debug as I've had no problems with README's (https://www.npmjs.com/package/cf-component-modal)

[ianwremmel]

I heard back from npm. It is indeed a result of the dist-tags technique used by lerna. npm has an open issue: https://github.com/npm/newww/issues/389#issuecomment-188428605

[ianwremmel]

Ok, it's a hack, but a I got some help from npm and there's at least a way we can trick npm into rebuilding the readme.

First, add "-readmehack" to the end of the package version in package.json, then:

npm publish
npm dist-tag add ciscospark@0.6.3 latest
npm unpublish ciscospark@0.6.3-readmehack

[jamiebuilds]

I don't really want to put a hack like that into lerna. The publishing process is already very complex and that adds a lot of complexity

[ianwremmel]

Agreed, I'm not suggesting that gets hacked in, but it at least helps those with the problem until npm fixes the bug.

[ianwremmel]

In my case, I only actually have one readme I need to update, so I can put that in my publish script pretty trivially.

[danigb]

I'm having the same issue...

[jamiebuilds]

Locking this. I want an update just as much as everyone, but please just follow the actual issue on npm: https://github.com/npm/newww/issues/389

Edit (@gigabo): Looks like the npm ticket moved here: https://github.com/npm/registry/issues/42

(Thanks @ben-eb & @bebraw for pointing that out)

[hzoo]

Alright!!! An update to this issue: it should be fixed (via npm side)!

So I just published 6.22.0 yesterday and was thinking about publishing to the latest tag first instead of first lerna-temp then moving to latest but forgot. Then I was checking the readme's and it looked like they were already updated magically!?

Turns out @bcoe had been working on fixing this issue, so it looks like it's all good for us on this one?

it now renders the README directly from the package, rather than pulling it out at publish time.

---

We haven't published a new babel version in a month (>30 days)

Example with babel-core:

https://www.npmjs.com/package/babel-core

https://github.com/babel/babel/pull/5101/files (5 days ago)

EDIT:

😍😍😍😍😍😍
😍😍😍😍😍😍

[gigabo]

Awesome! Finally! 🎉

[ianwremmel]

Awesome! Thanks @bcoe! The emoji don't exist to express my excitement!

[bcoe]

Thanks! Giving credit where credit is due, the whole backend team at npm has been working on infrastructure this makes solving problems like this much easier (we've been rolling out a database that was @chrisdickinson's mad-science idea). I'm really excited to make the tag workflow elegant, for the community and for the benefit of my own OSS projects.

[tomwayson]

I'm confused. It sounds like @hzoo is saying that the npm website now picks up the README from whatever's on master in GitHub repository. I have not experienced this in my own projects, looking though issues for the npm website and registry for whatever changes were alluded to above, I see comments like this which make it seem like that is not the case at all.

@bcoe would you be able to shed light on the behavior we should expect, or point to any docs or at least the changes above?

Thanks!

[bcoe]

@tomwayson Hey 👋

So, rather than always pointing to the last published README file, we now point to whatever README is pointed to by the latest tag of npm. so, if you have a workflow in which you publish to a beta tag (as an example) and then use npm dist-tag add to switch this tag, you will see the appropriate README after the swap has taken place.

[lock]

This thread has been automatically locked because there has not been any recent activity after it was closed. Please open a new issue for related bugs.