feat(pg): Install Sphinx fork during sphinx install #1421
Conversation
|
This PR changes implementation code, but doesn't include a changeset. Did you forget to add one? |
RPate97
force-pushed
the
pate/sphinxup
branch
2 times, most recently
from
52e2f59 to
c65ceab
Compare
RPate97
force-pushed
the
pate/sphinxup
branch
2 times, most recently
from
5c49612 to
d4dd0e6
Compare
docs/cli-existing-project.md
Outdated
| 6. [Add remapping](#6-add-remapping) | ||
| 7. [Update your deployment script](#7-update-your-deployment-script)\ | ||
| 2. [Install Sphinx CLI](#2-install-sphinx-cli) | ||
| 3. [Install Sphinx Foundry library](#3-install-sphinx-foundry-library) |
There was a problem hiding this comment.
#3 needs to be updated (the name and the link, which is dead)
| foundryup --repo sphinx-labs/foundry --branch sphinx-patch-v0.1.0 | ||
| ``` | ||
|
|
||
| > If you run into problems installing our Foundry fork, [try steps in the troubleshooting guide](https://github.com/sphinx-labs/sphinx/blob/main/docs/troubleshooting-guide.md#installing-sphinxs-foundry-fork). If you are still unable to resolve the issue, please reach out in the [Discord](https://discord.gg/7Gc3DK33Np). We're always happy to help. |
There was a problem hiding this comment.
If you run into problems installing our Foundry fork, try steps in the troubleshooting guide. If you are still unable to resolve the issue, please reach out in the Discord. We're always happy to help.
Should we keep this? Looks like it's removed in this PR
There was a problem hiding this comment.
If you don't think the troubleshooting guide is necessary anymore, can you delete it?
There was a problem hiding this comment.
I don’t think the troubleshooting guide is necessary. I’ll remove it. We can reintroduce it if we see people running into problems with the installation process.
| Use the `sphinx install` command to install the Sphinx Foundry library. | ||
| ## 3. Install Sphinx Foundry Library and Fork | ||
|
|
||
| Use the `sphinx install` command to install the Sphinx Foundry library and Foundry fork. |
There was a problem hiding this comment.
Love that this is in a single command
| foundryup --repo sphinx-labs/foundry --branch sphinx-patch-v0.1.0 | ||
| ``` | ||
|
|
||
| > If you run into problems installing our Foundry fork, [try steps in the troubleshooting guide](https://github.com/sphinx-labs/sphinx/blob/main/docs/troubleshooting-guide.md#installing-sphinxs-foundry-fork). If you are still unable to resolve the issue, please reach out in the [Discord](https://discord.gg/7Gc3DK33Np). We're always happy to help. |
There was a problem hiding this comment.
If you run into problems installing our Foundry fork, try steps in the troubleshooting guide. If you are still unable to resolve the issue, please reach out in the Discord. We're always happy to help.
Should we keep this? Looks like it's removed in this PR
| ) => { | ||
| if (!confirm) { | ||
| await userConfirmation( | ||
| 'Would you like to install the Sphinx Foundry fork? This is required to use Sphinx and will replace your existing foundry instllation.\nConfirm? (y\\n):' |
| ) => { | ||
| if (!confirm) { | ||
| await userConfirmation( | ||
| 'Would you like to install the Sphinx Foundry fork? This is required to use Sphinx and will replace your existing foundry instllation.\nConfirm? (y\\n):' |
There was a problem hiding this comment.
instllation -> installation
packages/plugins/src/cli/setup.ts
Outdated
| default: false, | ||
| }) | ||
| .option(confirmOption, { | ||
| describe: 'Confirm the deployment without displaying a preview.', |
There was a problem hiding this comment.
This describe sentence doesn't make sense in this context
packages/plugins/src/cli/setup.ts
Outdated
| @@ -136,10 +136,25 @@ export const makeCLI = ( | |||
| .command( | |||
| 'install', | |||
| 'Installs the required version of the Sphinx Solidity library contracts', | |||
There was a problem hiding this comment.
Could update this description to mention the Foundry fork
|
If we're keeping the troubleshooting section, we need to update it to use |
RPate97
force-pushed
the
pate/sphinxup
branch
4 times, most recently
from
7ac23bf to
2795615
Compare
RPate97
force-pushed
the
pate/sphinxup
branch
from
2795615 to
076aeee
Compare
Purpose
sphinx installcommand to install the Sphinx Foundy fork binariesfoundryupyarn sphinx install —confirminstead of using the foundry GitHub action integrationTodo