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: Python Quality Check and Formatting | |
| # Controls when the workflow will run | |
| on: | |
| push: | |
| branches: [master, main] | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| workflow_dispatch: | |
| defaults: | |
| run: | |
| working-directory: . | |
| # The sequence of runs in this workflow: | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check OS Version | |
| run: lsb_release -a | |
| - name: Show Kernel Information | |
| run: uname -a | |
| - name: Check out Repository Code | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true # Fetch submodules | |
| fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod | |
| - name: Cache pre-commit | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Set up the environment | |
| uses: ./.github/actions/setup-python-env | |
| - name: Build sphinx files | |
| run: just build | |
| - name: Deploy to GitHub Pages | |
| uses: crazy-max/ghaction-github-pages@v4 | |
| if: (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main') | |
| with: | |
| # the output branch mentioned above | |
| target_branch: gh-pages | |
| build_dir: ./build | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |