doc: improve readme file and doc #21
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: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up PDM | |
| uses: pdm-project/setup-pdm@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: true | |
| - name: Install dependencies | |
| run: | | |
| pdm sync --no-editable | |
| - name: Run static code analysis | |
| run: | | |
| pdm lint | |
| - name: Run Tests | |
| run: | | |
| pdm test --junit-xml=test-results.xml --cov-report xml:coverage.xml | tee pytest-coverage.txt | |
| - name: Publish tests result | |
| if: always() | |
| uses: pmeier/pytest-results-action@main | |
| with: | |
| path: test-results.xml | |
| summary: true | |
| fail-on-empty: true | |
| # (Optional) Title of the test results section in the workflow summary | |
| title: Tests result - ${{ matrix.python-version }} | |
| name: Code Coverage Summary Report | |
| - name: Pubish code coverage | |
| if: always() | |
| uses: irongut/[email protected] | |
| with: | |
| filename: coverage.xml |