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

Npm package publishing #138

Closed
grod220 opened this issue Oct 25, 2023 · 3 comments · Fixed by #672
Closed

Npm package publishing #138

grod220 opened this issue Oct 25, 2023 · 3 comments · Fixed by #672
Assignees
Labels
ci/cd Deployment and github action related

Comments

@grod220
Copy link
Contributor

grod220 commented Oct 25, 2023

We need a strategy/method on how we publish our @penumbra-zone/<package> 's. How often should we do this? Is there a way CI/CD can automatically detect diffs of packages and publish the new version?

@github-project-automation github-project-automation bot moved this to 🗄️ Backlog in Penumbra web Oct 25, 2023
@grod220 grod220 added the ci/cd Deployment and github action related label Jan 5, 2024
@TalDerei TalDerei closed this as completed Feb 9, 2024
@github-project-automation github-project-automation bot moved this from 🗄️ Backlog to ✅ Done in Penumbra web Feb 9, 2024
@TalDerei TalDerei reopened this Feb 9, 2024
@github-project-automation github-project-automation bot moved this from ✅ Done to 🏗 In progress in Penumbra web Feb 9, 2024
@TalDerei
Copy link
Contributor

TalDerei commented Feb 9, 2024

Referenced in #218. The NPM publishing workflow exists in a state where the web app and extension are synchronized, and the dialogue between them hasn't been the source of breaking changes. The combination of protobuf spec changes and new testnet deployments, without publishing an updated extension, was the major source of breakage. Finalizing the protobuf spec penumbra-zone/penumbra#3720 helps, but there are still pain points related to web-related breaking changes if there's a mismatch between web app and state of the extension.

One track we've discussed is a multi-branch workflow (which @hdevalence doesn't like) where we have a development branch that we merge things into instead of main acting as the deployment branch. The main branch would act as what's in production, and the dev branch would be what's in preview. This would increase the complexity of the workflow, but it's one method to reduce the number of breaking changes. @conorsch iirc, you already do this implicitly when we release a point release in the monorepo.

Another track would be an additional manual github action, where the GitHub action would be a production web app deployment. We’d have the existing continuous deployments going to a preview, and the secondary one would be a manual action whenever we publish or there's an extension update. This has also been recently discussed as a viable option.

@TalDerei TalDerei moved this from 🏗 In progress to 📝 Todo in Penumbra web Feb 9, 2024
@grod220
Copy link
Contributor Author

grod220 commented Feb 9, 2024

At the moment, given things are in flux, we are simply deploying the web app + extension manually via github actions. However, maybe after a month or two, we should return to continuous deployment of the web app (assuming the messaging api is stable).

This issue really had in mind third-party wallets (keplr, leap) that we eventually will want to expose all of our work. We want them (with fairly little effort) to be able to import and use these packages to enable using Penumbra for their users. However, at the moment, we aren't publishing them to npm.

@TalDerei TalDerei moved this from 📝 Todo to 🗄️ Backlog in Penumbra web Feb 9, 2024
@grod220 grod220 moved this from 🗄️ Backlog to 📝 Todo in Penumbra web Feb 22, 2024
@grod220 grod220 self-assigned this Mar 1, 2024
@grod220 grod220 moved this from 📝 Todo to 🏗 In progress in Penumbra web Mar 1, 2024
@grod220
Copy link
Contributor Author

grod220 commented Mar 13, 2024

This tracking issue #729, with the broken down tasks, should be the new thing to track

@grod220 grod220 closed this as not planned Won't fix, can't repro, duplicate, stale Mar 13, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Penumbra web Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd Deployment and github action related
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants