README.md update plus better error handling for No Topic case. (#69) #123
This file contains 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: "Static analysis & tests" | |
on: | |
push: | |
branches: [ "master" ] | |
pull_request: | |
jobs: | |
analysis: | |
runs-on: ubuntu-latest | |
name: Pylint Analysis | |
steps: | |
- name: Checkout repository | |
uses: actions/[email protected] | |
with: | |
persist-credentials: false | |
- name: Set up Python | |
uses: actions/[email protected] | |
with: | |
python-version: '3.11' | |
cache: 'pip' | |
- name: Install dependencies | |
run: | | |
pip install -r requirements.txt | |
- name: Analyze code with Pylint | |
id: analyze-code | |
run: | | |
pylint_score=$(pylint $(git ls-files '*.py') | grep 'rated at' | awk '{print $7}' | cut -d'/' -f1) | |
echo "PYLINT_SCORE=$pylint_score" >> $GITHUB_ENV | |
- name: Check Pylint score | |
run: | | |
if (( $(echo "$PYLINT_SCORE < 9.5" | bc -l) )); then | |
echo "Failure: Pylint score is below 9.5 (project score: $PYLINT_SCORE)." | |
exit 1 | |
else | |
echo "Success: Pylint score is above 9.5 (project score: $PYLINT_SCORE)." | |
fi | |
code-format-check: | |
runs-on: ubuntu-latest | |
name: Black Format Check | |
steps: | |
- name: Checkout repository | |
uses: actions/[email protected] | |
with: | |
persist-credentials: false | |
- name: Set up Python | |
uses: actions/[email protected] | |
with: | |
python-version: '3.11' | |
cache: 'pip' | |
- name: Install dependencies | |
run: | | |
pip install -r requirements.txt | |
- name: Check code format with Black | |
id: check-format | |
run: | | |
black --check $(git ls-files '*.py') | |
python-tests: | |
runs-on: ubuntu-latest | |
name: Python Tests | |
steps: | |
- name: Checkout repository | |
uses: actions/[email protected] | |
with: | |
fetch-depth: 0 | |
persist-credentials: false | |
- name: Set up Python | |
uses: actions/[email protected] | |
with: | |
python-version: '3.11' | |
cache: 'pip' | |
- name: Install dependencies | |
run: | | |
pip install -r requirements.txt | |
- name: Set PYTHONPATH environment variable | |
run: echo "PYTHONPATH=${GITHUB_WORKSPACE}/living_documentation_generator/living_documentation_generator" >> $GITHUB_ENV | |
- name: Check code coverage with Pytest | |
run: pytest --cov=. -v tests/ --cov-fail-under=80 |