chore: Update some stale readme content #1475
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: CI | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| env: | |
| PYTHON_VERSION: "3.10" | |
| PIPELINE_FAMILY: "general" | |
| jobs: | |
| setup: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| id: virtualenv-cache | |
| with: | |
| path: | | |
| .venv | |
| key: ci-venv-${{ env.PIPELINE_FAMILY }}-${{ hashFiles('requirements/base.txt') }} | |
| - name: Set up Python ${{ env.PYTHON_VERSION }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Setup virtual environment (no cache hit) | |
| if: steps.virtualenv-cache.outputs.cache-hit != 'true' | |
| run: | | |
| python${{ env.PYTHON_VERSION }} -m venv .venv | |
| source .venv/bin/activate | |
| make install-ci | |
| lint: | |
| runs-on: ubuntu-latest | |
| needs: setup | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| id: virtualenv-cache | |
| with: | |
| path: | | |
| .venv | |
| key: ci-venv-${{ env.PIPELINE_FAMILY }}-${{ hashFiles('requirements/base.txt') }} | |
| - name: Lint | |
| run: | | |
| source .venv/bin/activate | |
| make check | |
| shellcheck: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: ShellCheck | |
| uses: ludeeus/action-shellcheck@master | |
| test: | |
| runs-on: ubuntu-latest-m | |
| needs: [setup, lint] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| id: virtualenv-cache | |
| with: | |
| path: | | |
| .venv | |
| key: ci-venv-${{ env.PIPELINE_FAMILY }}-${{ hashFiles('requirements/base.txt') }} | |
| - name: Run core tests | |
| run: | | |
| source .venv/bin/activate | |
| sudo apt-get update && sudo apt-get install --yes poppler-utils libreoffice | |
| make install-pandoc | |
| sudo add-apt-repository -y ppa:alex-p/tesseract-ocr5 | |
| sudo apt-get install -y tesseract-ocr tesseract-ocr-kor | |
| tesseract --version | |
| make install-nltk-models | |
| make test | |
| make check-coverage | |
| changelog: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - if: github.ref != 'refs/heads/main' | |
| uses: dorny/paths-filter@v3 | |
| id: changes | |
| with: | |
| filters: | | |
| src: | |
| - 'doc_recipe/**' | |
| - 'recipe-notebooks/**' | |
| - if: steps.changes.outputs.src == 'true' && github.ref != 'refs/heads/main' | |
| uses: dangoslen/changelog-enforcer@v3 | |
| # TODO - figure out best practice for caching docker images | |
| # (Using the virtualenv to get pytest) | |
| test_dockerfile: | |
| runs-on: ubuntu-latest-m | |
| needs: [setup, lint] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| id: virtualenv-cache | |
| with: | |
| path: | | |
| .venv | |
| key: ci-venv-${{ env.PIPELINE_FAMILY }}-${{ hashFiles('requirements/base.txt') }} | |
| - name: Test Dockerfile | |
| run: | | |
| source .venv/bin/activate | |
| make docker-build | |
| make docker-test | |
| # - name: Scan image | |
| # uses: anchore/scan-action@v3 | |
| # with: | |
| # image: "pipeline-family-${{ env.PIPELINE_FAMILY }}-dev" | |
| # # NOTE(robinson) - revert this to medium when we bump libreoffice | |
| # severity-cutoff: critical |