Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document release process better for pushing changes to NPM #116

Open
3 tasks
mrchrisadams opened this issue Oct 7, 2022 · 1 comment
Open
3 tasks

Document release process better for pushing changes to NPM #116

mrchrisadams opened this issue Oct 7, 2022 · 1 comment

Comments

@mrchrisadams
Copy link
Member

mrchrisadams commented Oct 7, 2022

Right now, we use the tool np to automate some of the steps for publishing code to npm.

I don't think I fully understand how the version numbers are updated in the source code compared to on npm, and it has lead to a few confused releases of new code to npm, like with a recent shortlived push of what would have been a patch release
taking us to 0.11.1 causing a deploy of 0.10.5.

This issue is to document our release process better, and if necessary check with folks who deploy npm packages more frequently than us using np, so we have a predictable and drama-free way to release code.

Stuff to cover:

  • how to publish a patch release
  • how to publish a minor release
  • what to do if make a mistake (i.e. understanding the unpublishing process)
@fershad
Copy link
Contributor

fershad commented Oct 8, 2024

@mrchrisadams we've got this now published in our Readme, as well as details about where releases will be communicated as well. Okay for this issue to be closed?

https://github.com/thegreenwebfoundation/co2.js?tab=readme-ov-file#publishing-to-npm

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

No branches or pull requests

2 participants