[PUI] Tweaks #12085
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
| # Checks for each PR / push | |
| name: QC | |
| on: | |
| push: | |
| branches-ignore: ["l10*"] | |
| pull_request: | |
| branches-ignore: ["l10*"] | |
| env: | |
| python_version: 3.9 | |
| node_version: 18 | |
| # The OS version must be set per job | |
| server_start_sleep: 60 | |
| requests_version: 2.31.0 | |
| pyyaml_version: 6.0.1 | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| INVENTREE_DB_ENGINE: sqlite3 | |
| INVENTREE_DB_NAME: inventree | |
| INVENTREE_MEDIA_ROOT: ../test_inventree_media | |
| INVENTREE_STATIC_ROOT: ../test_inventree_static | |
| INVENTREE_BACKUP_DIR: ../test_inventree_backup | |
| INVENTREE_SITE_URL: http://localhost:8000 | |
| permissions: | |
| contents: read | |
| jobs: | |
| paths-filter: | |
| name: Filter | |
| runs-on: ubuntu-latest | |
| outputs: | |
| server: ${{ steps.filter.outputs.server }} | |
| migrations: ${{ steps.filter.outputs.migrations }} | |
| frontend: ${{ steps.filter.outputs.frontend }} | |
| api: ${{ steps.filter.outputs.api }} | |
| force: ${{ steps.force.outputs.force }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # [email protected] | |
| id: filter | |
| with: | |
| filters: | | |
| server: | |
| - 'src/backend/InvenTree/**' | |
| - 'src/backend/requirements.txt' | |
| - 'src/backend/requirements-dev.txt' | |
| migrations: | |
| - '**/test_migrations.py' | |
| - '**/migrations/**' | |
| - '.github/workflows**' | |
| - 'src/backend/requirements.txt' | |
| api: | |
| - 'src/backend/InvenTree/InvenTree/api_version.py' | |
| frontend: | |
| - 'src/frontend/**' | |
| - name: Is CI being forced? | |
| run: echo "force=true" >> $GITHUB_OUTPUT | |
| id: force | |
| if: | | |
| contains(github.event.pull_request.labels.*.name, 'dependency') || | |
| contains(github.event.pull_request.labels.*.name, 'full-run') | |
| javascript: | |
| name: Style - Classic UI [JS] | |
| runs-on: ubuntu-20.04 | |
| needs: ["pre-commit"] | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| npm: true | |
| install: true | |
| - name: Check Templated JS Files | |
| run: | | |
| cd .github/scripts | |
| python3 check_js_templates.py | |
| - name: Lint Javascript Files | |
| run: | | |
| python src/backend/InvenTree/manage.py prerender | |
| cd src/backend && npx eslint InvenTree/InvenTree/static_i18n/i18n/*.js | |
| pre-commit: | |
| name: Style [pre-commit] | |
| runs-on: ubuntu-20.04 | |
| needs: paths-filter | |
| if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.frontend == 'true' || needs.paths-filter.outputs.force == 'true' | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Set up Python ${{ env.python_version }} | |
| uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # [email protected] | |
| with: | |
| python-version: ${{ env.python_version }} | |
| cache: "pip" | |
| - name: Run pre-commit Checks | |
| uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # [email protected] | |
| - name: Check Version | |
| run: | | |
| pip install --require-hashes -r .github/requirements.txt | |
| python3 .github/scripts/version_check.py | |
| mkdocs: | |
| name: Style [Documentation] | |
| runs-on: ubuntu-20.04 | |
| needs: paths-filter | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Set up Python ${{ env.python_version }} | |
| uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # [email protected] | |
| with: | |
| python-version: ${{ env.python_version }} | |
| - name: Check Config | |
| run: | | |
| pip install --require-hashes -r .github/requirements.txt | |
| pip install --require-hashes -r docs/requirements.txt | |
| python docs/ci/check_mkdocs_config.py | |
| - name: Check Links | |
| uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368 # v1 | |
| with: | |
| folder-path: docs | |
| config-file: docs/mlc_config.json | |
| check-modified-files-only: "yes" | |
| use-quiet-mode: "yes" | |
| schema: | |
| name: Tests - API Schema Documentation | |
| runs-on: ubuntu-20.04 | |
| needs: paths-filter | |
| if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.force == 'true' | |
| env: | |
| INVENTREE_DB_ENGINE: django.db.backends.sqlite3 | |
| INVENTREE_DB_NAME: ../inventree_unit_test_db.sqlite3 | |
| INVENTREE_ADMIN_USER: testuser | |
| INVENTREE_ADMIN_PASSWORD: testpassword | |
| INVENTREE_ADMIN_EMAIL: [email protected] | |
| INVENTREE_PYTHON_TEST_SERVER: http://localhost:12345 | |
| INVENTREE_PYTHON_TEST_USERNAME: testuser | |
| INVENTREE_PYTHON_TEST_PASSWORD: testpassword | |
| outputs: | |
| version: ${{ steps.version.outputs.version }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| apt-dependency: gettext poppler-utils | |
| dev-install: true | |
| update: true | |
| - name: Export API Documentation | |
| run: invoke schema --ignore-warnings --filename src/backend/InvenTree/schema.yml | |
| - name: Upload schema | |
| uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # [email protected] | |
| with: | |
| name: schema.yml | |
| path: src/backend/InvenTree/schema.yml | |
| - name: Download public schema | |
| if: needs.paths-filter.outputs.api == 'false' | |
| run: | | |
| pip install --require-hashes -r .github/requirements.txt >/dev/null 2>&1 | |
| version="$(python3 .github/scripts/version_check.py only_version 2>&1)" | |
| echo "Version: $version" | |
| url="https://raw.githubusercontent.com/inventree/schema/main/export/${version}/api.yaml" | |
| echo "URL: $url" | |
| curl -s -o api.yaml $url | |
| echo "Downloaded api.yaml" | |
| - name: Check for differences in API Schema | |
| if: needs.paths-filter.outputs.api == 'false' | |
| run: | | |
| diff --color -u src/backend/InvenTree/schema.yml api.yaml | |
| diff -u src/backend/InvenTree/schema.yml api.yaml && echo "no difference in API schema " || exit 2 | |
| - name: Check schema - including warnings | |
| run: invoke schema | |
| continue-on-error: true | |
| - name: Extract version for publishing | |
| id: version | |
| if: github.ref == 'refs/heads/master' && needs.paths-filter.outputs.api == 'true' | |
| run: | | |
| pip install --require-hashes -r .github/requirements.txt >/dev/null 2>&1 | |
| version="$(python3 .github/scripts/version_check.py only_version 2>&1)" | |
| echo "Version: $version" | |
| echo "version=$version" >> "$GITHUB_OUTPUT" | |
| schema-push: | |
| name: Push new schema | |
| runs-on: ubuntu-20.04 | |
| needs: [paths-filter, schema] | |
| if: needs.schema.result == 'success' && github.ref == 'refs/heads/master' && needs.paths-filter.outputs.api == 'true' && github.repository_owner == 'inventree' | |
| env: | |
| version: ${{ needs.schema.outputs.version }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| with: | |
| repository: inventree/schema | |
| token: ${{ secrets.SCHEMA_PAT }} | |
| - name: Download schema artifact | |
| uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7 | |
| with: | |
| name: schema.yml | |
| - name: Move schema to correct location | |
| run: | | |
| echo "Version: $version" | |
| mkdir export/${version} | |
| mv schema.yml export/${version}/api.yaml | |
| - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1 | |
| with: | |
| commit_message: "Update API schema for ${version}" | |
| python: | |
| name: Tests - inventree-python | |
| runs-on: ubuntu-20.04 | |
| needs: ["pre-commit", "paths-filter"] | |
| if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.force == 'true' | |
| env: | |
| wrapper_name: inventree-python | |
| INVENTREE_DB_ENGINE: django.db.backends.sqlite3 | |
| INVENTREE_DB_NAME: ../inventree_unit_test_db.sqlite3 | |
| INVENTREE_ADMIN_USER: testuser | |
| INVENTREE_ADMIN_PASSWORD: testpassword | |
| INVENTREE_ADMIN_EMAIL: [email protected] | |
| INVENTREE_PYTHON_TEST_SERVER: http://127.0.0.1:12345 | |
| INVENTREE_PYTHON_TEST_USERNAME: testuser | |
| INVENTREE_PYTHON_TEST_PASSWORD: testpassword | |
| INVENTREE_SITE_URL: http://127.0.0.1:12345 | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| apt-dependency: gettext poppler-utils | |
| dev-install: true | |
| update: true | |
| npm: true | |
| - name: Download Python Code For `${{ env.wrapper_name }}` | |
| run: git clone --depth 1 https://github.com/inventree/${{ env.wrapper_name }} ./${{ env.wrapper_name }} | |
| - name: Start InvenTree Server | |
| run: | | |
| invoke delete-data -f | |
| invoke import-fixtures | |
| invoke server -a 127.0.0.1:12345 & | |
| invoke wait | |
| - name: Run Tests For `${{ env.wrapper_name }}` | |
| run: | | |
| cd ${{ env.wrapper_name }} | |
| invoke check-server | |
| coverage run -m unittest discover -s test/ | |
| coverage: | |
| name: Tests - DB [SQLite] + Coverage ${{ matrix.python_version }} | |
| runs-on: ubuntu-20.04 | |
| needs: ["pre-commit", "paths-filter"] | |
| if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.force == 'true' | |
| continue-on-error: true # continue if a step fails so that coverage gets pushed | |
| strategy: | |
| matrix: | |
| python_version: [3.9, 3.12] | |
| env: | |
| INVENTREE_DB_NAME: ./inventree.sqlite | |
| INVENTREE_DB_ENGINE: sqlite3 | |
| INVENTREE_PLUGINS_ENABLED: true | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| python_version: ${{ matrix.python_version }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| apt-dependency: gettext poppler-utils | |
| dev-install: true | |
| update: true | |
| - name: Data Export Test | |
| uses: ./.github/actions/migration | |
| - name: Test Translations | |
| run: invoke translate | |
| - name: Check Migration Files | |
| run: python3 .github/scripts/check_migration_files.py | |
| - name: Coverage Tests | |
| run: invoke test --coverage | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@84508663e988701840491b86de86b666e8a86bed # [email protected] | |
| if: always() | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| slug: inventree/InvenTree | |
| flags: backend | |
| postgres: | |
| name: Tests - DB [PostgreSQL] | |
| runs-on: ubuntu-20.04 | |
| needs: ["pre-commit", "paths-filter"] | |
| if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.force == 'true' | |
| env: | |
| INVENTREE_DB_ENGINE: django.db.backends.postgresql | |
| INVENTREE_DB_USER: inventree | |
| INVENTREE_DB_PASSWORD: password | |
| INVENTREE_DB_HOST: "127.0.0.1" | |
| INVENTREE_DB_PORT: 5432 | |
| INVENTREE_DEBUG: info | |
| INVENTREE_CACHE_HOST: localhost | |
| INVENTREE_PLUGINS_ENABLED: true | |
| services: | |
| postgres: | |
| image: postgres:14 | |
| env: | |
| POSTGRES_USER: inventree | |
| POSTGRES_PASSWORD: password | |
| ports: | |
| - 5432:5432 | |
| redis: | |
| image: redis | |
| ports: | |
| - 6379:6379 | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| apt-dependency: gettext poppler-utils libpq-dev | |
| pip-dependency: psycopg django-redis>=5.0.0 | |
| dev-install: true | |
| update: true | |
| - name: Run Tests | |
| run: invoke test | |
| - name: Data Export Test | |
| uses: ./.github/actions/migration | |
| mysql: | |
| name: Tests - DB [MySQL] | |
| runs-on: ubuntu-20.04 | |
| needs: ["pre-commit", "paths-filter"] | |
| if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.force == 'true' | |
| env: | |
| # Database backend configuration | |
| INVENTREE_DB_ENGINE: django.db.backends.mysql | |
| INVENTREE_DB_USER: root | |
| INVENTREE_DB_PASSWORD: password | |
| INVENTREE_DB_HOST: "127.0.0.1" | |
| INVENTREE_DB_PORT: 3306 | |
| INVENTREE_DEBUG: info | |
| INVENTREE_PLUGINS_ENABLED: true | |
| services: | |
| mysql: | |
| image: mysql:latest | |
| env: | |
| MYSQL_ALLOW_EMPTY_PASSWORD: yes | |
| MYSQL_DATABASE: ${{ env.INVENTREE_DB_NAME }} | |
| MYSQL_USER: inventree | |
| MYSQL_PASSWORD: password | |
| MYSQL_ROOT_PASSWORD: password | |
| options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 | |
| ports: | |
| - 3306:3306 | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| apt-dependency: gettext poppler-utils libmysqlclient-dev | |
| pip-dependency: mysqlclient | |
| dev-install: true | |
| update: true | |
| - name: Run Tests | |
| run: invoke test | |
| - name: Data Export Test | |
| uses: ./.github/actions/migration | |
| migration-tests: | |
| name: Tests - Migrations [PostgreSQL] | |
| runs-on: ubuntu-latest | |
| needs: paths-filter | |
| if: ${{ (needs.paths-filter.outputs.force == 'true') || (github.ref == 'refs/heads/master' && needs.paths-filter.outputs.migrations == 'true') }} | |
| env: | |
| INVENTREE_DB_ENGINE: django.db.backends.postgresql | |
| INVENTREE_DB_NAME: inventree | |
| INVENTREE_DB_USER: inventree | |
| INVENTREE_DB_PASSWORD: password | |
| INVENTREE_DB_HOST: "127.0.0.1" | |
| INVENTREE_DB_PORT: 5432 | |
| INVENTREE_DEBUG: info | |
| INVENTREE_PLUGINS_ENABLED: false | |
| services: | |
| postgres: | |
| image: postgres:14 | |
| env: | |
| POSTGRES_USER: inventree | |
| POSTGRES_PASSWORD: password | |
| ports: | |
| - 5432:5432 | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| apt-dependency: gettext poppler-utils libpq-dev | |
| pip-dependency: psycopg | |
| dev-install: true | |
| update: true | |
| - name: Run Tests | |
| run: invoke test --migrations --report --coverage | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@84508663e988701840491b86de86b666e8a86bed # [email protected] | |
| if: always() | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| slug: inventree/InvenTree | |
| flags: migrations | |
| migrations-checks: | |
| name: Tests - Full Migration [SQLite] | |
| runs-on: ubuntu-latest | |
| needs: paths-filter | |
| if: ${{ (needs.paths-filter.outputs.force == 'true') || (github.ref == 'refs/heads/master' && needs.paths-filter.outputs.migrations == 'true') }} | |
| env: | |
| INVENTREE_DB_ENGINE: sqlite3 | |
| INVENTREE_DB_NAME: /home/runner/work/InvenTree/db.sqlite3 | |
| INVENTREE_DEBUG: info | |
| INVENTREE_PLUGINS_ENABLED: false | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| name: Checkout Code | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| install: true | |
| - name: Fetch Database | |
| run: git clone --depth 1 https://github.com/inventree/test-db ./test-db | |
| - name: Latest Database | |
| run: | | |
| cp test-db/latest.sqlite3 /home/runner/work/InvenTree/db.sqlite3 | |
| chmod +rw /home/runner/work/InvenTree/db.sqlite3 | |
| invoke migrate | |
| - name: 0.10.0 Database | |
| run: | | |
| rm /home/runner/work/InvenTree/db.sqlite3 | |
| cp test-db/stable_0.10.0.sqlite3 /home/runner/work/InvenTree/db.sqlite3 | |
| chmod +rw /home/runner/work/InvenTree/db.sqlite3 | |
| invoke migrate | |
| - name: 0.11.0 Database | |
| run: | | |
| rm /home/runner/work/InvenTree/db.sqlite3 | |
| cp test-db/stable_0.11.0.sqlite3 /home/runner/work/InvenTree/db.sqlite3 | |
| chmod +rw /home/runner/work/InvenTree/db.sqlite3 | |
| invoke migrate | |
| - name: 0.12.0 Database | |
| run: | | |
| rm /home/runner/work/InvenTree/db.sqlite3 | |
| cp test-db/stable_0.12.0.sqlite3 /home/runner/work/InvenTree/db.sqlite3 | |
| chmod +rw /home/runner/work/InvenTree/db.sqlite3 | |
| invoke migrate | |
| - name: 0.13.5 Database | |
| run: | | |
| rm /home/runner/work/InvenTree/db.sqlite3 | |
| cp test-db/stable_0.13.5.sqlite3 /home/runner/work/InvenTree/db.sqlite3 | |
| chmod +rw /home/runner/work/InvenTree/db.sqlite3 | |
| invoke migrate | |
| platform_ui: | |
| name: Tests - Platform UI | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 60 | |
| needs: ["pre-commit", "paths-filter"] | |
| if: needs.paths-filter.outputs.frontend == 'true' || needs.paths-filter.outputs.force == 'true' | |
| env: | |
| INVENTREE_DB_ENGINE: sqlite3 | |
| INVENTREE_DB_NAME: /home/runner/work/InvenTree/db.sqlite3 | |
| INVENTREE_DEBUG: True | |
| INVENTREE_PLUGINS_ENABLED: false | |
| VITE_COVERAGE: true | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| npm: true | |
| install: true | |
| update: true | |
| - name: Set up test data | |
| run: invoke setup-test -i | |
| - name: Rebuild thumbnails | |
| run: invoke rebuild-thumbnails | |
| - name: Install dependencies | |
| run: inv frontend-compile | |
| - name: Install Playwright Browsers | |
| run: cd src/frontend && npx playwright install --with-deps | |
| - name: Run Playwright tests | |
| id: tests | |
| run: cd src/frontend && npx nyc playwright test | |
| - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # pin@v4 | |
| if: ${{ !cancelled() && steps.tests.outcome == 'failure' }} | |
| with: | |
| name: playwright-report | |
| path: src/frontend/playwright-report/ | |
| retention-days: 14 | |
| - name: Report coverage | |
| if: always() | |
| run: cd src/frontend && npx nyc report --report-dir ./coverage --temp-dir .nyc_output --reporter=lcov --exclude-after-remap false | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@84508663e988701840491b86de86b666e8a86bed # [email protected] | |
| if: always() | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| slug: inventree/InvenTree | |
| flags: pui | |
| platform_ui_build: | |
| name: Build - UI Platform | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 60 | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # [email protected] | |
| - name: Environment Setup | |
| uses: ./.github/actions/setup | |
| with: | |
| npm: true | |
| - name: Install dependencies | |
| run: cd src/frontend && yarn install | |
| - name: Build frontend | |
| run: cd src/frontend && yarn run compile && yarn run build | |
| - name: Zip frontend | |
| run: | | |
| cd src/backend/InvenTree/web/static | |
| zip -r frontend-build.zip web/ web/.vite | |
| - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # [email protected] | |
| with: | |
| name: frontend-build | |
| path: src/backend/InvenTree/web/static/web |