ci: 💚 use sparse checkout and cache properly (#1803)

Signed-off-by: Eric Nemchik <eric@nemchik.com>
pull/1804/head
Eric Nemchik 4 months ago committed by GitHub
parent e92bb0b1a3
commit 83f5f75046
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -3,25 +3,40 @@ name: Build and Deploy Docs
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
build: build:
name: Build docs name: Build docs
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4.1.1 uses: actions/checkout@v4.1.1
- name: Set up Python with:
fetch-depth: 0
sparse-checkout: |
docs
images
includes
overrides
- name: Setup python
uses: actions/setup-python@v5.0.0 uses: actions/setup-python@v5.0.0
with: with:
python-version: 3.x python-version: 3.x
- name: Get pip cache directory
id: pip-cache
run: |
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
- name: Cache dependencies - name: Cache dependencies
uses: actions/cache@v4.0.0 uses: actions/cache@v4.0.0
with: with:
path: .cache path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-build-${{ hashFiles('docs/requirements.txt') }} key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies - name: Install dependencies
run: pip install -r docs/requirements.txt run: pip install -r docs/requirements.txt
- name: Build documentation - name: Build documentation
run: mkdocs build run: mkdocs build
deploy: deploy:
if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref) if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref)
needs: build needs: build
@ -33,16 +48,27 @@ jobs:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4.1.1 uses: actions/checkout@v4.1.1
with: with:
fetch-depth: '0' fetch-depth: 0
- name: Set up Python sparse-checkout: |
docs
images
includes
overrides
- name: Setup python
uses: actions/setup-python@v5.0.0 uses: actions/setup-python@v5.0.0
with: with:
python-version: 3.x python-version: 3.x
- name: Get pip cache directory
id: pip-cache
run: |
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
- name: Cache dependencies - name: Cache dependencies
uses: actions/cache@v4.0.0 uses: actions/cache@v4.0.0
with: with:
path: .cache path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-build-${{ hashFiles('docs/requirements.txt') }} key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies - name: Install dependencies
run: pip install -r docs/requirements.txt run: pip install -r docs/requirements.txt
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages

Loading…
Cancel
Save