bitnami / readme-generator-for-helm

Auto generate READMEs for Helm Charts
https://bitnami.com
Apache License 2.0
212 stars 48 forks source link

Publish on npm #36

Closed politician closed 1 year ago

politician commented 2 years ago

This should be published on npm for easier consumption

miguelaeh commented 2 years ago

Hi, There is already someone publishing it https://www.npmjs.com/package/readme-generator-for-helm

politician commented 2 years ago

Hi @miguelaeh Can I open a PR to add it to the README?

It would save some hassle when contributing to the bitnami charts repo.

miguelaeh commented 2 years ago

Sure!

politician commented 2 years ago

Ok I just did some due diligence before adding it: the author's fork is not automatically updated and differs slightly from the official repo.

Current options I see:

  1. @miguelaeh would it be possible to add a @bitnami NPM token in the GitHub actions secrets? I'm happy to draft an auto-publish action so this repo can publish to https://www.npmjs.com/package/@bitnami/readme-generator-for-helm
  2. @alexjamesmalcolm would you consider replacing the https://www.npmjs.com/package/readme-generator-for-helm with code from this repo and auto-publish on a schedule? You can achieve this with GH actions as well and I'm happy to help
  3. @alexjamesmalcolm if you don't want to be bothered, would you consider transferring the package to me?
alexjamesmalcolm commented 2 years ago

Hello, sorry for accidentally publishing this, I made a mistake when I was trying to publish it as @alexjamesmalcolm/readme-generator-for-helm. @miguelaeh, do you have any thoughts on me transferring the NPM package to @politician?

justusbunsi commented 2 years ago

Hi. Following this issue for a while now. Would there be any disadvantage of publishing it within the @bitnami namespace? It seems to be some sort of a deadlock situation right now; speaking from an external point of view.

agomezmoron commented 1 year ago

Hi @alexjamesmalcolm, we need you to transfer that npm package to Bitnami (https://www.npmjs.com/org/bitnami) because we are the maintainers. Please, could you let me know when you addressed it in order to work on our side to publish updates there?

Cheers

justusbunsi commented 1 year ago

Would it be a solution to rename the package in package.json to <at>bitnami/readme-generator-for-helm and publish it as such? That way the transfer wouldn't be necessary for this issue to be resolved. Or do you want to publish it outside the org scope on NPM?

Drawback: Different package name. Package usages referring to GitHub might be broken?

agomezmoron commented 1 year ago

Hi @justusbunsi, that's not the solution. The problem is @alexjamesmalcolm published our package under his scope and it shouldn't be in that way according to the product. That's why the easiest and cleanest solution IMHO is transferring the package to the org which it belongs to.

Thank you for the heads up!

justusbunsi commented 1 year ago

Fair point. Sounds reasonable. 👍

alexjamesmalcolm commented 1 year ago

Hello @agomezmoron.

I'm following this NPM documentation and trying to add "bitnami" as a maintainer and then remove myself, thus transferring ownership. The problem is that "bitnami" is an organization and you cannot invite organizations.

I was able to find @miguelaeh on NPM as angelrb so I have invited @miguelaeh to be a maintainer. Once @miguelaeh accepts the invitation I'll remove myself and then hopefully it can be managed under @bitnami somehow.

agomezmoron commented 1 year ago

Hi @alexjamesmalcolm,

Thank you. @miguelaeh is not part of Bitnami currently so I think the easiest easiest way can be:

Thanks

alexjamesmalcolm commented 1 year ago

@agomezmoron I unpublished/deleted the package.

agomezmoron commented 1 year ago

Thank you @alexjamesmalcolm , we will work in its publication then.

harjotgill commented 1 year ago

Waiting anxiously for this to get published as our CI is now broken! :)

agomezmoron commented 1 year ago

The package was published on npm and will keep publishing with the incoming changes.

I'll close this issue then.

Cheers

brsolomon-deloitte commented 1 year ago

It looks like @bitnami/readme-generator-for-helm is available on NPM, but the readme here still suggests installing from Git.