mirror of
https://github.com/storytold/craft-common-actions.git
synced 2026-11-13 05:52:45 +00:00
113 lines
4.7 KiB
YAML
113 lines
4.7 KiB
YAML
name: SonarCloud
|
|
|
|
on:
|
|
workflow_call:
|
|
inputs:
|
|
project-key:
|
|
description: "SonarCloud project key (defaults to storytold_<repo>)"
|
|
type: string
|
|
required: false
|
|
default: ""
|
|
fonts-ref:
|
|
description: "craft-fonts commit for tests that lay out text (empty skips the checkout)"
|
|
type: string
|
|
required: false
|
|
default: ""
|
|
secrets:
|
|
SONAR_TOKEN:
|
|
description: "SonarCloud analysis token"
|
|
required: false
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
sonarcloud:
|
|
name: SonarCloud Scan
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 60
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
with:
|
|
fetch-depth: 0
|
|
persist-credentials: false
|
|
- name: Check for SonarCloud token
|
|
id: token
|
|
env:
|
|
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
|
run: |
|
|
if [ -n "$SONAR_TOKEN" ]; then
|
|
echo "available=true" >>"$GITHUB_OUTPUT"
|
|
else
|
|
echo "available=false" >>"$GITHUB_OUTPUT"
|
|
echo "::notice::SONAR_TOKEN is not available (e.g. a fork pull request); skipping SonarCloud scan."
|
|
fi
|
|
- name: Validate SonarCloud project key
|
|
id: project
|
|
if: steps.token.outputs.available == 'true'
|
|
shell: bash
|
|
env:
|
|
PROJECT_KEY: ${{ inputs.project-key != '' && inputs.project-key || format('storytold_{0}', github.event.repository.name) }}
|
|
LC_ALL: C
|
|
run: |
|
|
# The scan action splits args; reject characters that could introduce properties.
|
|
if [[ ! "$PROJECT_KEY" =~ ^[a-zA-Z0-9_.:-]+$ ]]; then
|
|
echo "::error::Invalid SonarCloud project key: use only letters, digits, dash, underscore, period or colon."
|
|
exit 1
|
|
fi
|
|
printf 'key=%s\n' "$PROJECT_KEY" >>"$GITHUB_OUTPUT"
|
|
- name: Check out craft-fonts
|
|
if: steps.token.outputs.available == 'true'
|
|
uses: storytold/craft-common-actions/actions/checkout-craft-fonts@main
|
|
with:
|
|
ref: ${{ inputs.fonts-ref }}
|
|
- name: Free disk space
|
|
# The instrumented workspace build overflows the ~14 GB free on a stock runner.
|
|
if: steps.token.outputs.available == 'true' && hashFiles('Cargo.toml') != ''
|
|
run: sudo rm -rf /usr/share/dotnet /usr/local/lib/android /opt/ghc /opt/hostedtoolcache/CodeQL
|
|
- name: Install Linux build dependencies
|
|
if: steps.token.outputs.available == 'true' && hashFiles('Cargo.toml') != ''
|
|
uses: storytold/craft-common-actions/actions/install-apt-packages@main
|
|
with:
|
|
packages: >-
|
|
pkg-config libxkbcommon-dev libwayland-dev libx11-dev libxcursor-dev libxrandr-dev
|
|
libxi-dev libgtk-3-dev libfontconfig1-dev libfreetype-dev libasound2-dev
|
|
libgl1-mesa-dev mesa-vulkan-drivers
|
|
- name: Install Rust and cargo-llvm-cov
|
|
if: steps.token.outputs.available == 'true' && hashFiles('Cargo.toml') != ''
|
|
run: |
|
|
rustup toolchain install stable --profile minimal --component llvm-tools-preview
|
|
rustup default stable
|
|
- uses: taiki-e/install-action@8cca0918f8471c33515202b73f56ab27f2bed283 # v2.87.29
|
|
if: steps.token.outputs.available == 'true' && hashFiles('Cargo.toml') != ''
|
|
with:
|
|
tool: cargo-llvm-cov
|
|
- uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
|
|
if: steps.token.outputs.available == 'true' && hashFiles('Cargo.toml') != ''
|
|
with:
|
|
save-if: ${{ github.ref == 'refs/heads/main' }}
|
|
- name: Generate Rust coverage
|
|
id: coverage
|
|
if: steps.token.outputs.available == 'true' && hashFiles('Cargo.toml') != ''
|
|
# A red test must not hide the static analysis, so keep going and scan what was measured.
|
|
continue-on-error: true
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
CRAFT_FONTS_DIR: ${{ github.workspace }}/craft-fonts
|
|
# Coverage comes from instrumentation, not DWARF; debuginfo is most of target/.
|
|
CARGO_PROFILE_DEV_DEBUG: "0"
|
|
run: >
|
|
cargo llvm-cov --workspace --ignore-run-fail --lcov --output-path lcov.info
|
|
--ignore-filename-regex '(^|/)(vendor|xtask)/'
|
|
- name: SonarCloud Scan
|
|
if: steps.token.outputs.available == 'true'
|
|
uses: SonarSource/sonarqube-scan-action@d209202bc7d53ff1cc128f7f907dac145c9d6ae9 # v8.3.0
|
|
env:
|
|
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
|
SONAR_HOST_URL: https://sonarcloud.io
|
|
with:
|
|
args: >
|
|
"-Dsonar.projectKey=${{ steps.project.outputs.key }}"
|
|
-Dsonar.organization=storytold
|
|
-Dsonar.rust.lcov.reportPaths=lcov.info
|