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 process for releasing a library #21

Open
xinnanyemm opened this issue Dec 8, 2022 · 2 comments
Open

Document process for releasing a library #21

xinnanyemm opened this issue Dec 8, 2022 · 2 comments

Comments

@xinnanyemm
Copy link

xinnanyemm commented Dec 8, 2022

Create a document that includes the instructions we give at the end of the README for the module template (and thus all of our repos). This way, we can just link to this document from all of our repos instead of pasting those instructions over and over.

@mcmire mcmire changed the title Procedures: Releasing a library Document process for releasing a library Aug 18, 2023
@xinnanyemm
Copy link
Author

@Gudahtt
Copy link
Member

Gudahtt commented Sep 28, 2023

This task is for documenting the release process for single-package repositories specifically. Our monorepo release documentation for core is within core.

Note that this documentation is already in the README of our module template (here) and in the README of many other repositories. This task would be to centralize this in our contributor documentation and make whatever other improvements seem appropriate.

However we have a few different scenarios across our repositories that we should account for here as well:

  • Fully automated with Slack notifications (as reflected in the current module template instructions)
  • Fully automated without Slack notifications
  • Partially automated (GitHub release publishing is automated but not npm publishing)
  • Fully manual publishing

The instructions for the very last step are a little different for these three cases.

The module template instructions apply for fully-automated repositories with Slack notifications.

For repositories without Slack notifications, we should add that the person preparing/merging the release should ping the @metamask-npm-publishers group on Slack to ask for the package to be published to npm

For fully manual releases, the person preparing the release should also manually create the GitHub release and tag first, after merging the release but before pinging the npm publishers group.

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

5 participants