Joss paper #4158
Workflow file for this run
This file contains hidden or 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
| name: Documentation | |
| on: | |
| push: | |
| branches: [ main, master, develop ] | |
| pull_request: | |
| branches: [ main, master, develop ] | |
| workflow_dispatch: | |
| jobs: | |
| doc-coverage: | |
| name: Check Documentation Coverage | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| timeout-minutes: 2 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| timeout-minutes: 3 | |
| - name: Check documentation coverage | |
| run: | | |
| cd docfiles | |
| python3 check_doc_coverage.py --json ../doc-coverage.json | |
| timeout-minutes: 3 | |
| - name: Check documentation quality | |
| run: | | |
| cd docfiles | |
| python3 check_doc_quality.py | |
| timeout-minutes: 2 | |
| - name: Display coverage | |
| run: | | |
| echo "Documentation Coverage Results:" | |
| cat doc-coverage.json | python3 -m json.tool | |
| timeout-minutes: 1 | |
| - name: Upload coverage report | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: doc-coverage-report | |
| path: doc-coverage.json | |
| retention-days: 90 | |
| timeout-minutes: 2 | |
| - name: Generate badge | |
| run: | | |
| COVERAGE=$(cat doc-coverage.json | python3 -c "import sys, json; print(f\"{json.load(sys.stdin)['overall_coverage']:.1f}\")") | |
| echo "COVERAGE=$COVERAGE" >> $GITHUB_ENV | |
| echo "Documentation coverage: $COVERAGE%" | |
| timeout-minutes: 1 |