utopia-ui/.github/workflows/deploy.docs.yml
Ulf Gebhardt eb4b8788bb
feat(docu): generate coverage badge (#162)
* generate coverage badge

generate coverage badge in docs generation workflow in order to upload
it with the documentation

* include badge in readme, correct image name & json path

* job names, json path

* remove coverage branch from workflow
2025-02-28 19:56:03 +00:00

68 lines
1.8 KiB
YAML

name: deploy:docs
on:
push:
branches:
- main
jobs:
# Build job
build:
# Specify runner + build & upload the static files as an artifact
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.1.7
- uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.0.3
with:
node-version-file: './.tool-versions'
- name: Install Dependencies & Build Library
run: |
npm install
npm run build
working-directory: ./
- name: Build static files
id: build
run: npm run docs:generate
working-directory: ./
- name: Generate coverage
id: coverage
run: npm run test:unit
- name: Create coverage badges
id: coverage-badge
uses: jaywcjlove/coverage-badges-cli@main
with:
style: flat
source: coverage/coverage-summary.json
output: docs/test-coverage.svg
jsonPath: total.lines.pct
- name: Upload static files as artifact
id: deployment
uses: actions/upload-pages-artifact@v3.0.1
with:
path: docs/
# Deploy job
deploy:
# Add a dependency to the build job
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4.0.5