From 7a42d32e00035c930d02d1f3be0fd5699b04c35c Mon Sep 17 00:00:00 2001 From: Arturo Beccar-Varela <107512933+arturoBeccar@users.noreply.github.com> Date: Fri, 19 Apr 2024 13:48:37 -0300 Subject: [PATCH 1/5] Add Troubleshooting Guide --- docs/docs/intro.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 4acb0fc4..8c42144a 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -106,3 +106,48 @@ You'll also need to have installed the CLI, as the extension uses the CLI to per ### Usage After you've installed the extension, simply open a project workspace that contains any Soroban (.rs) files. You will see potential issues and warnings via a wiggle underline of the relevant code. + + +## Troubleshooting Guide + +### 1. Installation Troubleshooting + +**Issue**: Difficulties installing dependencies and Scout. + +**Solution**: + +- For Dylint: + +To install necessary libraries for Dylint, run the following commands: + ```bash + sudo apt install libssl-dev + sudo apt install pkg-config + ``` + +- For C Compiler (gcc). + +To install gcc, which is required for some components, use: + ```bash + sudo apt install gcc + ``` + +- For error `error[E0658]`. + +When encountering this error `error[E0658]: use of unstable library feature 'stdsimd'`, run cargo clean and ensure you are using this version of rustup: +```bash + cargo clean + rustup default nightly-2023-12-16 + ``` + +### 2. Crossed Contract Calls + +**Issue**: Scout encounters issues when analyzing contracts that perform crossed calls. + +**Solution**: +- When encountering problems with crossed calls, it's beneficial to compile the dependent contract first. Run the following command to build the second contract: +```bash + soroban contract build +``` + + + From e4a7a6e51b8bb7ede7e49ccc81603bbef123efa7 Mon Sep 17 00:00:00 2001 From: Jose Garcia Crosta Date: Tue, 23 Apr 2024 12:12:16 -0300 Subject: [PATCH 2/5] Update CI and pnpm-lock --- .github/workflows/test-deploy-docs.yml | 6 +++--- docs/pnpm-lock.yaml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/test-deploy-docs.yml b/.github/workflows/test-deploy-docs.yml index abe3ae3a..f74d24ca 100644 --- a/.github/workflows/test-deploy-docs.yml +++ b/.github/workflows/test-deploy-docs.yml @@ -75,6 +75,6 @@ jobs: body: | 📘 **Documentation Test Summary** 📘 - ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The test build of the documentation has completed successfully. 🚀\n') }} - ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The changes will be published upon merge to the main branch') }} - ${{ (needs.test-deploy.outputs.build-success != 'true' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨') }} + ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The test build of the documentation has completed successfully. 🚀\n' || '') }} + ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The changes will be published upon merge to the main branch' || '') }} + ${{ (needs.test-deploy.outputs.build-success != 'true' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨' || '') }} diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml index 79646f13..e0d687bb 100644 --- a/docs/pnpm-lock.yaml +++ b/docs/pnpm-lock.yaml @@ -1,4 +1,4 @@ -lockfileVersion: '6.1' +lockfileVersion: '6.0' settings: autoInstallPeers: true From ccfec8fc63f87407128f466b3cdb4d2c37ab81f3 Mon Sep 17 00:00:00 2001 From: Jose Garcia Crosta Date: Tue, 23 Apr 2024 12:15:57 -0300 Subject: [PATCH 3/5] Update comment --- .github/workflows/test-deploy-docs.yml | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/.github/workflows/test-deploy-docs.yml b/.github/workflows/test-deploy-docs.yml index f74d24ca..192acc2c 100644 --- a/.github/workflows/test-deploy-docs.yml +++ b/.github/workflows/test-deploy-docs.yml @@ -12,7 +12,7 @@ jobs: name: Test deployment runs-on: ubuntu-latest outputs: - build-success: ${{ steps.build.outputs.success }} + status: ${{ job.status }} defaults: run: working-directory: ./docs @@ -47,10 +47,7 @@ jobs: - name: Test build website id: build - run: | - if pnpm build; then - echo "build-success=true" >> $GITHUB_ENV - fi + run: pnpm build comment-on-pr: name: Comment on PR @@ -75,6 +72,6 @@ jobs: body: | 📘 **Documentation Test Summary** 📘 - ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The test build of the documentation has completed successfully. 🚀\n' || '') }} - ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The changes will be published upon merge to the main branch' || '') }} - ${{ (needs.test-deploy.outputs.build-success != 'true' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨' || '') }} + ${{ (needs.test-deploy.outputs.status == 'true' && 'The test build of the documentation has completed successfully. 🚀\n' || '') }} + ${{ (needs.test-deploy.outputs.status == 'true' && 'The changes will be published upon merge to the main branch' || '') }} + ${{ (needs.test-deploy.outputs.status != 'true' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨' || '') }} From 5451a796d35f2b4599fbbde7be9cba6f37f637ba Mon Sep 17 00:00:00 2001 From: Jose Garcia Crosta Date: Tue, 23 Apr 2024 12:17:46 -0300 Subject: [PATCH 4/5] Edit comment --- .github/workflows/test-deploy-docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test-deploy-docs.yml b/.github/workflows/test-deploy-docs.yml index 192acc2c..6434f961 100644 --- a/.github/workflows/test-deploy-docs.yml +++ b/.github/workflows/test-deploy-docs.yml @@ -72,6 +72,6 @@ jobs: body: | 📘 **Documentation Test Summary** 📘 - ${{ (needs.test-deploy.outputs.status == 'true' && 'The test build of the documentation has completed successfully. 🚀\n' || '') }} - ${{ (needs.test-deploy.outputs.status == 'true' && 'The changes will be published upon merge to the main branch' || '') }} - ${{ (needs.test-deploy.outputs.status != 'true' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨' || '') }} + ${{ (needs.test-deploy.outputs.status == 'success' && 'The test build of the documentation has completed successfully. 🚀\n' || '') }} + ${{ (needs.test-deploy.outputs.status == 'success' && 'The changes will be published upon merge to the main branch' || '') }} + ${{ (needs.test-deploy.outputs.status != 'success' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨' || '') }} From d88766223d702c87d5ea8ffb18ae50d69e91a13f Mon Sep 17 00:00:00 2001 From: Jose Garcia Crosta Date: Tue, 23 Apr 2024 12:20:38 -0300 Subject: [PATCH 5/5] Final comment edit --- .github/workflows/test-deploy-docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test-deploy-docs.yml b/.github/workflows/test-deploy-docs.yml index 6434f961..80afe1ad 100644 --- a/.github/workflows/test-deploy-docs.yml +++ b/.github/workflows/test-deploy-docs.yml @@ -72,6 +72,6 @@ jobs: body: | 📘 **Documentation Test Summary** 📘 - ${{ (needs.test-deploy.outputs.status == 'success' && 'The test build of the documentation has completed successfully. 🚀\n' || '') }} - ${{ (needs.test-deploy.outputs.status == 'success' && 'The changes will be published upon merge to the main branch' || '') }} - ${{ (needs.test-deploy.outputs.status != 'success' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨' || '') }} + ${{ (needs.test-deploy.outputs.status == 'success' && '✅ The test build of the documentation has completed successfully!' || '') }} + ${{ (needs.test-deploy.outputs.status == 'success' && '📝 The changes will be published upon merge to the main branch.' || '') }} + ${{ (needs.test-deploy.outputs.status != 'success' && '🚨 There was an issue with the test build of the documentation, please check the logs for more details.' || '') }}