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

updated github action and extension docs #247

Merged
merged 3 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ jobs:
with:
node-version: 20

- uses: pnpm/action-setup@v3
- uses: pnpm/action-setup@v4
name: Install pnpm
with:
version: 9
version: 9.15.4
run_install: false

- name: Get pnpm store directory
Expand All @@ -42,7 +42,7 @@ jobs:
restore-keys: ${{ runner.os }}-pnpm-store-

- name: Install dependencies
run: pnpm install --frozen-lockfile
run: pnpm install

- name: Build website
run: pnpm build
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release-extension.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ jobs:
node-version: 20

- name: Install pnpm
uses: pnpm/action-setup@v3
uses: pnpm/action-setup@v4
with:
version: 9
version: 9.15.4
run_install: false

- name: Get pnpm store directory
Expand All @@ -43,7 +43,7 @@ jobs:

- name: Install dependencies and vsce
run: |
pnpm install --frozen-lockfile
pnpm install
pnpm install -g vsce

- name: Build extension
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/test-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ jobs:
with:
node-version: 20

- uses: pnpm/action-setup@v3
- uses: pnpm/action-setup@v4
name: Install pnpm
with:
version: 9
version: 9.15.4
run_install: false

- name: Get pnpm store directory
Expand All @@ -42,7 +42,7 @@ jobs:
restore-keys: ${{ runner.os }}-pnpm-store-

- name: Install dependencies
run: pnpm install --frozen-lockfile
run: pnpm install

- name: Test build website
id: build
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/features/scout-github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ jobs:
- uses: mshick/add-pr-comment@v2.8.2
with:
message-path: ${{ github.workspace }}/report.md

# Optional: Add the following step to block the merge of the commit if Scout finds any issues.

- name: Check for error
run: |
if [ -f "${{ github.workspace }}/FAIL" ]; then
echo "Error: Scout found issues."
exit 1
fi
```

## Considerations
Expand Down
16 changes: 15 additions & 1 deletion docs/docs/features/vs-code-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,21 @@ Add Scout to your development workspace with our VS Code extension and run Scout

![Scout VS Code extension.](../../static/img/vscode-extension.png)

:warning: To ensure the extension runs properly, make sure that you open the directory containing your smart contract, rather than the entire project. For example, if your smart contracts are located in `myproject/contracts`, and you want to work on the `token` contract while using the Scout VS Code Extension, open `myproject/contracts/token`.
## Usage

Once installed and enabled, the Scout Audit item appears in your VS Code status bar.

![Scout VS Code extension.](../../static/img/scout-extension-status-bar.png)

When you open a file that Scout can analyze, the Scout Audit item becomes enabled. Clicking it initiates the execution of Scout.

The Scout Audit Output window provides additional details, such as relevant dependencies detected, the workspace being analyzed, and any errors encountered during execution.

![Scout VS Code extension.](../../static/img/scout-extension-output.png)

All findings from Scout are displayed in the Problems window.

![Scout VS Code extension.](../../static/img/scout-extension-findings-tab.png)

:bulb: Tip: To see the errors highlighted in your code, we recommend installing the [Error Lens Extension](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

.cardDescription_PWke {
.cardContainer_fWXF p {
display: none;
}
Binary file added docs/static/img/scout-extension-findings-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/scout-extension-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/scout-extension-status-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading