readme improvements #38
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: lint | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| inputs: | |
| debug: | |
| description: 'Set to on, to open ssh debug session.' | |
| required: true | |
| default: 'off' | |
| jobs: | |
| linting: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| # run static analysis on bleeding and trailing edges | |
| python-version: [ '3.8', '3.10', '3.12', '3.13.0-rc.1' ] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| - name: Install Dependencies | |
| run: | | |
| poetry config virtualenvs.in-project true | |
| poetry run pip install --upgrade pip | |
| poetry install | |
| - name: Install Emacs | |
| if: ${{ github.event.inputs.debug == 'on' }} | |
| run: | | |
| sudo apt install emacs | |
| - name: Setup tmate session | |
| if: ${{ github.event.inputs.debug == 'on' }} | |
| uses: mxschmitt/action-tmate@v3 | |
| with: | |
| detached: true | |
| timeout-minutes: 60 | |
| - name: Run Static Analysis | |
| run: | | |
| source .venv/bin/activate | |
| ./check.sh --no-fix | |
| python -m readme_renderer ./README.md -o /tmp/README.html | |
| echo "$(poetry env info --path)/bin" >> $GITHUB_PATH |