general: switch from deprecated apprdirs to platformdirs, update readme #271
Workflow file for this run
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
| # see https://github.com/karlicoss/pymplate for up-to-date reference | |
| name: CI | |
| on: | |
| push: | |
| branches: '*' | |
| tags: 'v[0-9]+.*' # only trigger on 'release' tags for PyPi | |
| # Ideally I would put this in the pypi job... but github syntax doesn't allow for regexes there :shrug: | |
| # P.S. fuck made up yaml DSLs. | |
| pull_request: # needed to trigger on others' PRs | |
| # Note that people who fork it need to go to "Actions" tab on their fork and click "I understand my workflows, go ahead and enable them". | |
| workflow_dispatch: # needed to trigger workflows manually | |
| # todo cron? | |
| inputs: | |
| debug_enabled: | |
| type: boolean | |
| description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)' | |
| required: false | |
| default: false | |
| jobs: | |
| build: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| platform: [ubuntu-latest, macos-latest] # todo windows-latest] | |
| python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] | |
| # vvv just an example of excluding stuff from matrix | |
| # exclude: [{platform: macos-latest, python-version: '3.6'}] | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation | |
| - run: echo "$HOME/.local/bin" >> $GITHUB_PATH | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: false # we don't have lock files, so can't use them as cache key | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 # nicer to have all git history when debugging/for tests | |
| - uses: mxschmitt/action-tmate@v3 | |
| if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }} | |
| # explicit bash command is necessary for Windows CI runner, otherwise it thinks it's cmd... | |
| - run: bash .ci/run | |
| - if: matrix.platform == 'ubuntu-latest' # no need to compute coverage for other platforms | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| include-hidden-files: true | |
| name: .coverage.mypy_${{ matrix.platform }}_${{ matrix.python-version }} | |
| path: .coverage.mypy/ | |
| pypi: | |
| runs-on: ubuntu-latest | |
| needs: [build] # add all other jobs here | |
| permissions: | |
| # necessary for Trusted Publishing | |
| id-token: write | |
| steps: | |
| # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation | |
| - run: echo "$HOME/.local/bin" >> $GITHUB_PATH | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: false # we don't have lock files, so can't use them as cache key | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: 'release to test pypi' | |
| # always deploy merged master to test pypi | |
| if: github.event_name != 'pull_request' && github.event.ref == 'refs/heads/master' | |
| run: .ci/release-uv --use-test-pypi | |
| - name: 'release to pypi' | |
| # always deploy tags to release pypi | |
| # NOTE: release tags are guarded by on: push: tags on the top | |
| if: github.event_name != 'pull_request' && startsWith(github.event.ref, 'refs/tags') | |
| run: .ci/release-uv |