rustframe/.github/workflows/docs-and-testcov.yml
2025-05-01 01:02:09 +01:00

102 lines
2.9 KiB
YAML

name: docs-and-testcov
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
on:
push:
branches: [main]
# pull_request:
# branches: [main]
workflow_dispatch:
permissions:
contents: read
id-token: write
pages: write
jobs:
docs-and-testcov:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Build documentation
run: cargo doc --no-deps --release
- name: Prepare documentation for Pages
run: |
- name: Install Cargo binstall
uses: cargo-bins/cargo-binstall@main
- name: Install cargo-tarpaulin via binstall
run: cargo binstall cargo-tarpaulin --no-confirm --locked
- name: Generate coverage report
run: |
mkdir -p testcov
cargo tarpaulin --engine llvm --out Html --out Json
- name: Check for tarpaulin-report.html
run: |
if [ ! -f tarpaulin-report.html ]; then
echo "tarpaulin-report.html not found!"
exit 1
fi
- name: Export tarpaulin coverage badge JSON
run: |
# extract raw coverage
coverage=$(jq '.coverage' tarpaulin-report.json)
# round to 2 decimal places
formatted=$(printf "%.2f" "$coverage")
# build the badge JSON using the pre-formatted string
jq --arg message "$formatted" \
'{schemaVersion:1,
label:"tarpaulin-report",
message:$message,
color:"blue"}' \
tarpaulin-report.json \
> tarpaulin-badge.json
- name: Save last commit date JSON
run: |
last_commit_date=$(git log -1 --format=%cd --date=short)
jq --arg date "$last_commit_date" \
'{schemaVersion:1,
label:"last-commit-date",
message:$date,
color:"blue"}' \
<(echo '{}') \
> last-commit-date.json
- name: Copy files to output directory
run: |
mkdir output
cp tarpaulin-report.html target/doc/rustframe/
cp tarpaulin-report.json target/doc/rustframe/
cp tarpaulin-badge.json target/doc/rustframe/
cp last-commit-date.json target/doc/rustframe/
mkdir -p target/doc/rustframe/.github
cp .github/rustframe_logo.png target/doc/rustframe/.github/
echo "<meta http-equiv=\"refresh\" content=\"0; url=rustframe\">" > target/doc/index.html
- name: Upload Pages artifact
if: github.event_name == 'push'
uses: actions/upload-pages-artifact@v3
with:
path: target/doc/
- name: Deploy to GitHub Pages
if: github.event_name == 'push'
uses: actions/deploy-pages@v4