Skip to content

Commit

Permalink
ci: unify solidity ci (#314)
Browse files Browse the repository at this point in the history
Summary
--
- Unify all Solidity CI jobs under a single workflow with concurrency.
- Trigger workflow only when path `contract/` is changed.
- All other workflow ignore `contracts/`.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a new continuous integration workflow for Solidity smart
contracts, including testing, linting, and static analysis.
- Added a command to update dependencies before deploying smart
contracts.

- **Bug Fixes**
- Removed unnecessary contract-related jobs from testing and linting
workflows to streamline processes.

- **Chores**
- Removed outdated workflows related to Solidity analysis and contract
testing.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
fbac authored Dec 10, 2024
1 parent 896e00c commit b95ff7e
Show file tree
Hide file tree
Showing 6 changed files with 138 additions and 91 deletions.
19 changes: 4 additions & 15 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ on:
push:
branches:
- main
paths-ignore:
- "contracts/**"
pull_request:
paths-ignore:
- "contracts/**"
permissions:
contents: read
jobs:
Expand All @@ -28,18 +32,3 @@ jobs:
uses: nickcharlton/diff-check@main
with:
command: dev/lint-golines
contracts:
name: Lint (Contracts)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
with:
version: "nightly-ac81a53d1d5823919ffbadd3c65f081927aa11f2"
- run: forge --version
- name: Run Forge fmt
# only format code, we do not want to format LIB
run: forge fmt contracts/src --check
51 changes: 0 additions & 51 deletions .github/workflows/solidity-slither.yml

This file was deleted.

124 changes: 124 additions & 0 deletions .github/workflows/solidity.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: CI Solidity

on:
push:
branches:
- main
paths:
- "contracts/**"
pull_request:
paths:
- "contracts/**"

concurrency:
group: ci-solidity-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
working-directory: contracts

jobs:
init:
runs-on: ubuntu-latest
strategy:
fail-fast: true

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1

- name: Install dependencies
run: forge soldeer update

- name: Build contracts
run: forge build

- name: Cache data
uses: actions/cache@v4
with:
path: contracts
key: ci-solidity-${{ github.ref }}

- id: forge
run: echo "FORGE_PATH=$(which forge)" >> $GITHUB_OUTPUT

- name: Upload forge
uses: actions/upload-artifact@v4
with:
name: forge
path: ${{ steps.forge.outputs.FORGE_PATH }}

test:
needs: init
runs-on: ubuntu-latest
steps:
- name: Restore cache
uses: actions/cache@v4
with:
path: contracts
key: ci-solidity-${{ github.ref }}

- name: Restore forge
uses: actions/download-artifact@v4
with:
name: forge
path: /usr/local/bin

- run: chmod +x /usr/local/bin/forge

- name: Run Forge tests
run: forge test -vvv

lint:
needs: init
runs-on: ubuntu-latest
steps:
- name: Restore cache
uses: actions/cache@v4
with:
path: contracts
key: ci-solidity-${{ github.ref }}

- name: Restore forge
uses: actions/download-artifact@v4
with:
name: forge
path: /usr/local/bin

- run: chmod +x /usr/local/bin/forge

- name: Run Forge fmt
run: forge fmt contracts/src --check

slither:
needs: init
runs-on: ubuntu-latest
steps:
- name: Restore cache
uses: actions/cache@v4
with:
path: contracts
key: ci-solidity-${{ github.ref }}

- name: Restore forge
uses: actions/download-artifact@v4
with:
name: forge
path: /usr/local/bin

- run: chmod +x /usr/local/bin/forge

- name: Install Slither
run: pip3 install slither-analyzer

- name: Run Slither
run: slither . --sarif output.sarif

- name: Upload SARIF file
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: contracts/output.sarif
29 changes: 4 additions & 25 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ on:
push:
branches:
- main
paths-ignore:
- "contracts/**"
pull_request:
paths-ignore:
- "contracts/**"
jobs:
test:
name: Test (Node)
Expand Down Expand Up @@ -38,28 +42,3 @@ jobs:
service: xmtp-node-go
files: report.xml
env: ci
contracts:
name: Test (Contracts)
strategy:
fail-fast: true
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: recursive

- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1

- name: Run Forge build
working-directory: contracts
run: |
forge --version
forge soldeer update
forge build --sizes
- name: Run Forge tests
working-directory: contracts
run: |
forge test -vvv
id: test
3 changes: 3 additions & 0 deletions dev/contracts/deploy-ephemeral
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@ source dev/contracts/.env

cd ./contracts

# Update depencencies
forge soldeer update

forge create --legacy --json --broadcast --rpc-url $DOCKER_RPC_URL --private-key $PRIVATE_KEY "$1:$2"
3 changes: 3 additions & 0 deletions dev/contracts/deploy-testnet
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ set -euo

cd ./contracts

# Update depencencies
forge soldeer update

# Deploy the contract to the chain with the specified RPC URL and attempt to verify the SC code
function deploy_contract() {
forge create \
Expand Down

0 comments on commit b95ff7e

Please sign in to comment.