general: set min versionto 3.9, since 3.8 reached EOL #1247
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: | |
| 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, windows-latest] | |
| python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] | |
| exclude: [ | |
| # windows runners are pretty scarce, so let's only run lowest and highest python version | |
| {platform: windows-latest, python-version: '3.10'}, | |
| {platform: windows-latest, python-version: '3.11'}, | |
| {platform: windows-latest, python-version: '3.12'}, | |
| # same, macos is a bit too slow and ubuntu covers python quirks well | |
| {platform: macos-latest , python-version: '3.10'}, | |
| {platform: macos-latest , python-version: '3.11'}, | |
| {platform: macos-latest , python-version: '3.12'}, | |
| ] | |
| runs-on: ${{ matrix.platform }} | |
| # useful for 'optional' pipelines | |
| # continue-on-error: ${{ matrix.platform == 'windows-latest' }} | |
| 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: 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-core_${{ matrix.platform }}_${{ matrix.python-version }} | |
| path: .coverage.mypy-core/ | |
| - 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-misc_${{ matrix.platform }}_${{ matrix.python-version }} | |
| path: .coverage.mypy-misc/ | |
| # split in two pipelines to speedup running | |
| end2end_tests_chrome: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: mxschmitt/action-tmate@v3 | |
| if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }} | |
| - run: .ci/end2end/build_and_run.sh -k chrome | |
| end2end_tests_firefox: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - uses: mxschmitt/action-tmate@v3 | |
| if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }} | |
| - run: .ci/end2end/build_and_run.sh -k firefox | |
| install_and_run_test: | |
| # todo use setup-python thing? | |
| # todo run on macos too? | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - run: .ci/github-ci-compat | |
| - run: | | |
| # --use-pep517 is a work around for some breaking change in setuptools 66.0.0 | |
| # see https://github.com/pypa/setuptools/issues/3772#issuecomment-1384671296 | |
| python3 -m pip install --use-pep517 . | |
| export PATH=.ci/fake-systemd:$PATH | |
| tests/install_and_run | |
| pypi: | |
| runs-on: ubuntu-latest | |
| needs: [build, end2end_tests_chrome, end2end_tests_firefox, install_and_run_test] | |
| 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: 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' | |
| env: | |
| TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD_TEST }} | |
| run: pip3 install --user --upgrade build twine && .ci/release --test | |
| - 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') | |
| env: | |
| TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }} | |
| run: pip3 install --user --upgrade build twine && .ci/release | |
| ### | |
| build_extension: | |
| env: | |
| name: 'promnesia' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 # nicer to have all git history when debugging/for tests | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: '20' | |
| - run: extension/.ci/build --lint # debug version | |
| - run: extension/.ci/build --lint --release | |
| # TODO ugh. can't share github actions artifacts publicly... | |
| # TODO for fuck's sake... why does it end up named as .zip.zip ???? | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: '${{ env.name }}-chrome-debug-latest.zip' | |
| path: 'extension/dist/artifacts/chrome/${{ env.name }}_dev_-*.zip' | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: '${{ env.name }}-chrome-release-latest.zip' | |
| path: 'extension/dist/artifacts/chrome/${{ env.name }}-*.zip' | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: '${{ env.name }}-firefox-debug-latest.zip' | |
| path: 'extension/dist/artifacts/firefox/${{ env.name }}_dev_-*.zip' | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: '${{ env.name }}-firefox-release-latest.zip' | |
| path: 'extension/dist/artifacts/firefox/${{ env.name }}-*.zip' |