Skip to content

ci: set minimum python version to 3.8 #3

ci: set minimum python version to 3.8

ci: set minimum python version to 3.8 #3

Workflow file for this run

name: CI
on:
push:
pull_request:
merge_group:
permissions:
contents: read
env:
MINIMUM_PYTHON_VERSION: "3.8"
jobs:
lint:
name: ${{ matrix.task.name }} ${{ matrix.json-lib }} (${{ matrix.os }})
strategy:
max-parallel: 4
fail-fast: false
matrix:
# Only run checks for ubuntu
os: [ubuntu]
json-lib: [orjson]
task:
- name: Type check
run: make type-check
- name: Check formatting
run: make check-fmt
- name: Lint code
run: make lint
runs-on: ${{ matrix.os }}-latest
steps:
#----------------------------------------------
# check-out repo
#----------------------------------------------
- name: Check out repository
uses: actions/checkout@v4
#----------------------------------------------
# ----- install & configure python & rye -----
#----------------------------------------------
- name: Set up the environment
uses: ./.github/actions/setup-python-env
with:
python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
cache-extra-key: ${{ matrix.json-lib }}
#----------------------------------------------
# Install json library, if not using stock
#----------------------------------------------
- name: Install json library
if: matrix.json-lib != 'json'
run: make install-dev-${{ matrix.json-lib }}
#----------------------------------------------
# Run matrix task
#----------------------------------------------
- name: ${{ matrix.task.name }}
run: ${{ matrix.task.run }}
# coverage:
# name: "Test py-${{ matrix.python-version }} (${{ matrix.os }}) [jsonlib: ${{ matrix.json-lib }}]"
# strategy:
# max-parallel: 4
# fail-fast: false
# matrix:
# # ignore windows for now
# os: [ubuntu] #, macos] # , windows-latest]
# python-version:
# - "3.9"
# - "3.10"
# - "3.11"
# - "3.12"
# json-lib: [orjson, json]
# continue-on-error: >-
# ${{ contains(matrix.python-version, 'dev') && true || false }}
# runs-on: ${{ matrix.os }}-latest
# steps:
# #----------------------------------------------
# # check-out repo and set-up python
# #----------------------------------------------
# - name: Check out repository
# uses: actions/checkout@v4
# #----------------------------------------------
# # ----- install & configure python & rye -----
# #----------------------------------------------
# - name: Set up the environment
# uses: ./.github/actions/setup-python-env
# with:
# python-version: ${{ matrix.python-version }}
# cache-extra-key: ${{ matrix.json-lib }}
# #----------------------------------------------
# # Install json library, if not using stock
# #----------------------------------------------
# - name: Install json library
# if: matrix.json-lib != 'json'
# run: make install-dev-${{ matrix.json-lib }}
# #----------------------------------------------
# # Run tests and upload coverage
# #----------------------------------------------
# - name: Run tests for coverage
# run: make test-w-coverage
# - name: copy coverage
# run: |
# mkdir coverage
# cp -v .coverage coverage/.coverage.${{ matrix.os }}-py${{ matrix.python-version }}-${{ matrix.json-lib }}
# - name: store coverage files
# uses: actions/upload-artifact@v3
# with:
# name: coverage
# path: coverage
# upload-coverage:
# name: Upload test coverage to CodeCov
# needs: [coverage]
# runs-on: ubuntu-latest
# permissions:
# statuses: write
# steps:
# #----------------------------------------------
# # check-out repo and set-up python
# #----------------------------------------------
# - name: Check out repository
# uses: actions/checkout@v4
# - name: Set up python ${{ env.MINIMUM_PYTHON_VERSION }}
# id: setup-python
# uses: actions/setup-python@v5
# with:
# python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
# #----------------------------------------------
# # install dependencies if cache does not exist
# #----------------------------------------------
# - name: Install dependencies
# run: pip install coverage
# - name: download coverage files
# uses: actions/download-artifact@v3
# with:
# name: coverage
# path: coverage
# - name: convert coverage to xml
# run: |
# coverage combine --data-file=coverage/.coverage
# coverage xml -i --data-file=coverage/.coverage
# ls
# ls coverage
# - name: Upload coverage to Codecov
# uses: codecov/codecov-action@v3
# with:
# token: ${{ secrets.CODECOV_TOKEN }}
# # directory: ./coverage
# # env_vars: OS,PYTHON
# fail_ci_if_error: false
# # files: ./coverage/coverage.xml
# # flags: unittests
# # name: codecov-umbrella
# verbose: true
# https://github.com/marketplace/actions/alls-green#why used for branch protection checks
check:
if: always()
needs: [lint]
runs-on: ubuntu-latest
permissions: {}
steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}
# allowed-failures: coverage
build:
name: Build package
# only run on push to main and on release
if: success() && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
runs-on: ubuntu-latest
steps:
#----------------------------------------------
# check-out repo and set-up python
#----------------------------------------------
- name: Check out repository
uses: actions/checkout@v4
#----------------------------------------------
# ----- install & configure rye -----
#----------------------------------------------
- name: Install rye
id: setup-rye
uses: eifinger/setup-rye@5b24b104a68da1e2ea0073aa191a2bab66f55d7c
- name: Set up python ${{ env.MINIMUM_PYTHON_VERSION }}
run: rye pin ${{ env.MINIMUM_PYTHON_VERSION }}
#----------------------------------------------
# ----- build distribution -----
#----------------------------------------------
- name: Build distribution
run: rye build
#----------------------------------------------
# ----- upload artifacts -----
#----------------------------------------------
- uses: actions/upload-artifact@v4
with:
name: pypi_files
path: dist
test-build:
name: test build on ${{ matrix.os }}
needs: [build]
strategy:
fail-fast: false
matrix:
os: [ubuntu, macos, windows]
runs-on: ${{ matrix.os }}-latest
steps:
- uses: actions/checkout@v4
- name: set up python
uses: actions/setup-python@v5
with:
python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
- name: get dist artifacts
uses: actions/download-artifact@v4
with:
name: pypi_files
path: dist
- run: rm -r src/sparv_bert_neighbour
- run: pip install typing-extensions
- run: pip install -r tests/requirements-test.txt
- run: pip install sparv-bert-neighbour-plugin --no-index --no-deps --find-links dist --force-reinstall
- run: pytest
publish:
needs: [check, test-build]
if: success() && startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
environment: release
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python ${{ env.MINIMUM_PYTHON_VERSION }}
uses: actions/setup-python@v5
with:
python-version: ${{ env.MINIMUM_PYTHON_VERSION }}
- name: get dist artifacts
uses: actions/download-artifact@v4
with:
name: pypi_files
path: dist
- name: Publish package to PyPI
uses: pypa/gh-action-pypi-publish@release/v1