Added README to explain how to use the wikijs code injection function… #87
This file contains hidden or 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 Pipeline | |
| on: | |
| push: | |
| branches: | |
| - '**' | |
| pull_request: | |
| branches: | |
| - main | |
| permissions: | |
| contents: write | |
| checks: write | |
| pull-requests: write | |
| env: | |
| UV_SYSTEM_PYTHON: true | |
| jobs: | |
| linting-and-formatting: | |
| name: Ruff Lint & Format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Ruff Check | |
| uses: chartboost/ruff-action@v1 | |
| with: | |
| args: "check ." | |
| - name: Ruff Format Check | |
| uses: chartboost/ruff-action@v1 | |
| with: | |
| args: "format . --check" | |
| unit-tests-and-coverage: | |
| name: Unit Tests, Mypy & Coverage (Python ${{ matrix.python_version }}) | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python_version: ["3.10", "3.11", "3.12"] | |
| 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 uv | |
| run: curl -LsSf https://astral.sh/uv/install.sh | sh | |
| - name: Install dependencies | |
| run: | | |
| uv pip install -e '.[dev]' | |
| uv pip install coveralls | |
| - name: Mypy Type Checking | |
| if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref == 'refs/heads/main') | |
| run: | | |
| echo "Running Mypy because this is a pull request or a push to main..." | |
| python -m mypy --ignore-missing-imports --follow-imports=silent --no-strict-optional src/desi tests | |
| - name: Run Unit Tests & Build coverage file | |
| run: | | |
| pytest --cov-config=.coveragerc --junitxml=pytest.xml --cov=src/desi -m "not integration" --ignore=tests/cli --ignore=tests/metadata/test_entities_dict.py tests | tee pytest-coverage.txt | |
| - name: Pytest coverage comment | |
| if: matrix.python_version == '3.12' | |
| uses: MishaKav/pytest-coverage-comment@main | |
| with: | |
| pytest-coverage-path: pytest-coverage.txt | |
| junitxml-path: pytest.xml | |
| - name: Submit to coveralls | |
| if: matrix.python_version == '3.12' | |
| continue-on-error: true | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| coveralls --service=github | |
| # integration-tests: | |
| # name: Integration Tests | |
| # if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| # needs: [linting-and-formatting, unit-tests-and-coverage] | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - uses: actions/checkout@v4 | |
| # - name: Set up Python 3.12 | |
| # uses: actions/setup-python@v5 | |
| # with: | |
| # python-version: 3.12 | |
| # - name: Install uv | |
| # run: | | |
| # curl -LsSf https://astral.sh/uv/install.sh | sh | |
| # - name: Install dependencies | |
| # run: uv pip install -e '.[dev]' | |
| # - name: Run Integration Tests | |
| # run: | | |
| # python -m pytest -sv -m "integration" tests/ | |
| build-and-install: | |
| name: Build and Install | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Install uv | |
| run: | | |
| curl -LsSf https://astral.sh/uv/install.sh | sh | |
| - name: Build the package | |
| run: | | |
| uv pip install build | |
| python -m build --sdist | |
| - name: Install the package | |
| run: | | |
| uv pip install dist/*.tar.gz |