docs: update the fine-tuning examples #215
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
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: Test | |
| on: | |
| push: | |
| branches: [master, dev] | |
| pull_request: | |
| branches: [master, dev] | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-13] # add windows-2019 when poetry allows installation with `-f` flag | |
| python-version: [3.8, 3.9, '3.10'] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Get full Python version | |
| id: full-python-version | |
| shell: bash | |
| run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))") | |
| - name: Upgrade pip | |
| shell: bash | |
| run: python -m pip install --upgrade pip | |
| - name: Install dependencies | |
| shell: bash | |
| run: | | |
| pip install --no-cache-dir -r requirements.txt | |
| pip install --extra-index-url https://pypi.org/simple --no-cache-dir coverage pytest codecov-cli>=0.4.1 | |
| - name: Run unittest | |
| shell: bash | |
| # run: python -m unittest discover -s ./tests -p 'test_*.py' | |
| run: coverage run -m unittest discover -s ./tests -p 'test*.py' | |
| - name: Statistics | |
| if: success() | |
| run: | | |
| coverage report -i | |
| coverage xml -i | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/[email protected] | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| slug: longxingtan/open-retrievals | |
| docs: | |
| name: Test docs build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out Git repository | |
| uses: actions/checkout@v2 | |
| - name: Set up Python | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.8 | |
| - name: Cache pip | |
| uses: actions/cache@v2 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements_docs.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update && sudo apt-get install -y pandoc | |
| python -m pip install --upgrade pip | |
| pip install -r docs/requirements_docs.txt | |
| shell: bash | |
| - name: Build sphinx documentation | |
| run: | | |
| cd docs | |
| make clean | |
| make html --debug --jobs 2 SPHINXOPTS="-W" | |
| - name: Upload built docs | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs-results-${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.requires }} | |
| path: docs/build/html/ | |
| # Use always() to always run this step to publish test results when there are test failures | |
| if: success() |