Skip to content

Commit

Permalink
add badge
Browse files Browse the repository at this point in the history
  • Loading branch information
reschandreas committed Mar 15, 2024
1 parent acd71f8 commit c9e72a8
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 10 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ on:
- develop
paths:
- 'docs/**'
- '**.py'
- '.github/workflows/docs.yaml'

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
Expand All @@ -27,6 +28,19 @@ jobs:
with:
docs-folder: "docs/"
build-command: make html dirhtml
- name: Setup Python
uses: actions/[email protected]
with:
python-version: 3.11
- name: Install Python dependencies
run: pip install -qr cli/requirements.txt
- name: Generate coverage report
run: |
cd cli
coverage run -m unittest discover
coverage-badge -o coverage.svg
cd ..
sudo mv cli/coverage.svg docs/_build/dirhtml/_images/
- uses: actions/upload-artifact@v3
with:
name: Documentation
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/python-unit-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,4 @@ jobs:
echo "Coverage is less than 65%"
exit 1
fi
# Add this
- name: Update Coverage Badge
# GitHub actions: default branch variable
# https://stackoverflow.com/questions/64781462/github-actions-default-branch-variable
if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
uses: we-cli/coverage-badge-action@main
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

![tests](https://github.com/ls1intum/Aeolus/actions/workflows/docs.yaml/badge.svg)
![tests](https://github.com/ls1intum/Aeolus/actions/workflows/python-unit-tests.yaml/badge.svg)
![coverage](https://ls1intum.github.io/Aeolus/_images/coverage.svg)
![containers](https://github.com/ls1intum/Aeolus/actions/workflows/build-and-push.yaml/badge.svg)
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
![coverage](https://github.com/ls1intum/Aeolus/badges/coverage.svg)

On how to use Aeolus, please refer to the [documentation](https://ls1intum.github.io/Aeolus/).

Expand Down
6 changes: 3 additions & 3 deletions playground/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c9e72a8

Please sign in to comment.