sphinx-labs / sphinx

DevOps platform for smart contract deployments
MIT License
237 stars 15 forks source link

feat(pg): Register projects via the website #1667

Closed RPate97 closed 5 months ago

RPate97 commented 6 months ago

Purpose

Implements the mono repo logic required to switch to registering projects using the website.

Architecture

The high-level architecture for project management now looks like this:

Backward Compatability

This change is designed to be backward compatible on the website. The user will just no longer be able to register new projects via the propose API endpoint. So if a user continues to use the current version of our plugin, and uses a set of configuration options in their script that correctly match a project that is already registered on the website (correct project name, and Gnosis Safe options that resolve to the correct address), then they will be able to continue proposing to the website without issue. Being backward compatible in this way, will ensure that the release process for this change is as smooth as possible.

However, the changes in the mono repo are breaking changes because the user will need to update their script configuration options. See the migration guide for more information on that.

Testing

You should be able to test this entire change out by running the website locally. You'll just need to checkout this branch, and the corresponding branch in the website repo. You'll of course want to make sure that you have the mono repo packages linked in the website repo.

Once you have that all setup, you should be able to create a project using the UI and then propose using that project name from whatever script you want as long as you have it configured properly. See the migration guide included in this PR for more information on that.

Todo

mergify[bot] commented 6 months ago

This PR changes implementation code, but doesn't include a changeset. Did you forget to add one?