-
Notifications
You must be signed in to change notification settings - Fork 349
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add coverage to our test workflow (#1152)
- Loading branch information
1 parent
5cea01f
commit 4e40ad4
Showing
3 changed files
with
80 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,57 @@ | ||
name: Lint and test | ||
# This workflow runs linting and tests on all pull requests and pushes to the main branch. | ||
# It includes Markdown linting, Cairo formatting checks, running tests with coverage, | ||
# and uploading the coverage report to Codecov. | ||
|
||
on: | ||
pull_request: | ||
push: | ||
branches: | ||
- main | ||
- main | ||
|
||
jobs: | ||
lint_and_test: | ||
name: Lint and test | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Extract scarb version | ||
run: | | ||
SCARB_VERSION=$(grep 'scarb-version = ' Scarb.toml | sed 's/scarb-version = "\(.*\)"/\1/') | ||
echo "SCARB_VERSION=$SCARB_VERSION" >> "$GITHUB_ENV" | ||
- uses: software-mansion/setup-scarb@v1 | ||
with: | ||
scarb-version: ${{ env.SCARB_VERSION }} | ||
- name: Extract foundry version | ||
run: | | ||
FOUNDRY_VERSION=$(grep 'snforge_std = ' Scarb.toml | sed 's/snforge_std = "\(.*\)"/\1/') | ||
echo "FOUNDRY_VERSION=$FOUNDRY_VERSION" >> "$GITHUB_ENV" | ||
- uses: foundry-rs/setup-snfoundry@v3 | ||
with: | ||
starknet-foundry-version: ${{ env.FOUNDRY_VERSION }} | ||
- name: Markdown lint | ||
uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v16 | ||
with: | ||
globs: | | ||
*.md | ||
!PULL_REQUEST_TEMPLATE.md | ||
- name: Cairo lint | ||
run: scarb fmt --check --workspace | ||
- name: Cairo test | ||
run: snforge test --workspace | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Extract scarb version | ||
run: | | ||
SCARB_VERSION=$(grep 'scarb-version = ' Scarb.toml | sed 's/scarb-version = "\(.*\)"/\1/') | ||
echo "SCARB_VERSION=$SCARB_VERSION" >> "$GITHUB_ENV" | ||
- uses: software-mansion/setup-scarb@v1 | ||
with: | ||
scarb-version: ${{ env.SCARB_VERSION }} | ||
|
||
- name: Extract foundry version | ||
run: | | ||
FOUNDRY_VERSION=$(grep 'snforge_std = ' Scarb.toml | sed 's/snforge_std = "\(.*\)"/\1/') | ||
echo "FOUNDRY_VERSION=$FOUNDRY_VERSION" >> "$GITHUB_ENV" | ||
- uses: foundry-rs/setup-snfoundry@v3 | ||
with: | ||
starknet-foundry-version: ${{ env.FOUNDRY_VERSION }} | ||
|
||
- name: Install cairo-coverage | ||
run: curl -L https://raw.githubusercontent.com/software-mansion/cairo-coverage/main/scripts/install.sh | sh | ||
|
||
- name: Markdown lint | ||
uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v16 | ||
with: | ||
globs: | | ||
*.md | ||
!PULL_REQUEST_TEMPLATE.md | ||
- name: Cairo lint | ||
run: scarb fmt --check --workspace | ||
|
||
- name: Run tests and generate coverage report | ||
run: snforge test --workspace --coverage | ||
|
||
- name: Upload coverage to Codecov | ||
uses: codecov/codecov-action@v4 | ||
with: | ||
file: ./coverage.lcov | ||
token: ${{ secrets.CODECOV_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
comment: | ||
layout: "diff, files, header, footer" | ||
behavior: default | ||
|
||
coverage: | ||
# The value range where you want the value to be green | ||
# Hold ourselves to a high bar. | ||
range: 90..100 | ||
status: | ||
project: | ||
coverage: | ||
# Use the coverage from the base commit (pull request base) coverage to compare against. | ||
# Once we have a baseline we can be more strict. | ||
target: auto | ||
threshold: 2% | ||
patch: | ||
default: | ||
# Require new code to have 90%+ coverage. | ||
target: 90% | ||
threshold: 2% | ||
|
||
ignore: | ||
- "**/tests/**" | ||
- "docs/" | ||
- "scripts/" | ||
- "packages/test_common/" | ||
|
||
github_checks: | ||
annotations: false | ||
|