Skip to content
CI

Update the README #1556

Sign in to view logs

Update the README

Update the README #1556

Workflow file for this run

.github/workflows/ci.yml at 2930561
name: CI
on:
push:
branches:
- main
tags:
- "v*"
pull_request: {}
workflow_dispatch:
concurrency:
group: test-${{ github.ref }}
cancel-in-progress: true
jobs:
check-manifest:
name: Check Manifest
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check
run: pipx run check-manifest
test:
name: ${{ matrix.platform }} (${{ matrix.python-version }}) ${{ matrix.pydantic }}
runs-on: ${{ matrix.platform }}
strategy:
fail-fast: false
matrix:
python-version: [3.8, 3.9, "3.10", "3.11"]
platform: [ubuntu-latest, macos-latest, windows-latest]
pydantic: ["pydantic<2", "pydantic>2"]
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 dependencies
run: |
python -m pip install --upgrade pip
pip install "${{ matrix.pydantic }}"
pip install -e .[json,docs,testing]
- name: Test Main docs build
run: pytest --color yes -m github_main_only
- name: Test
run: |
coverage run --source=npe2 -m pytest --color yes
- name: Upload coverage as artifact
uses: actions/upload-artifact@v4
with:
name: coverage reports ${{ matrix.platform }} py ${{ matrix.python-version }} ${{ (matrix.pydantic == 'pydantic<2' && 'pydantic_lt_2') || 'pydantic_gt_2' }}
path: |
./.coverage.*
include-hidden-files: true
test_napari:
name: napari tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v4
with:
repository: napari/napari
path: napari-from-github
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install
run: |
python -m pip install --upgrade pip
python -m pip install -e ./napari-from-github -c "./napari-from-github/resources/constraints/constraints_py3.10.txt"
python -m pip install -e .[json]
# bare minimum required to test napari/plugins
python -m pip install pytest pytest-pretty scikit-image[data] zarr xarray hypothesis matplotlib
- name: Run napari plugin headless tests
run: pytest -W 'ignore::DeprecationWarning' napari/plugins napari/settings napari/layers napari/components
working-directory: napari-from-github
test_docs_render:
name: docs render
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Build schema
run: |
python -m pip install --upgrade pip
pip install -e .[docs] check-jsonschema
python -m npe2.manifest.schema > _schema.json
check-jsonschema --check-metaschema _schema.json
- name: Test rendering docs
run: python _docs/render.py
env:
NPE2_SCHEMA: "_schema.json"
upload_coverage:
needs: test
name: Upload coverage
if: always()
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.x"
cache-dependency-path: setup.cfg
cache: 'pip'
- name: Install Dependencies
run: |
pip install --upgrade pip
pip install codecov
- name: Download coverage data
uses: actions/download-artifact@v4
with:
pattern: coverage reports*
path: coverage
merge-multiple: true
- name: combine coverage data
run: |
python -Im coverage combine coverage
python -Im coverage xml -o coverage.xml
# Report and write to summary.
python -Im coverage report --format=markdown --skip-empty --skip-covered >> $GITHUB_STEP_SUMMARY
- name: Upload coverage data
uses: codecov/codecov-action@v4
with:
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
deploy:
name: Deploy
needs: test
if: "success() && startsWith(github.ref, 'refs/tags/')"
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: install
run: |
git tag
pip install -U pip
pip install -U twine build
python -m build .
twine check dist/*
ls -lh dist
- name: write schema
run: |
pip install -e . check-jsonschema
python -m npe2.manifest.schema > schema.json
check-jsonschema --check-metaschema schema.json
- name: Build and publish
run: twine upload dist/*
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.TWINE_API_KEY }}
- uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/')
with:
generate_release_notes: true
files: schema.json