Update README.md #36
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/CD | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - run: pip install poetry | |
| - run: poetry install --with dev | |
| - run: poetry run ruff format --check | |
| - run: poetry run ruff check | |
| - run: poetry run mypy src/ tests/ | |
| - run: poetry run pytest | |
| deploy: | |
| if: github.event_name == 'push' # Ensure deploy only runs on push, not pull_request | |
| needs: test | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - uses: actions/configure-pages@v5 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - run: pip install poetry | |
| - run: poetry install --with dev | |
| - run: poetry run mkslides build docs/index.md | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./site | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |