Add metadata to pipeline states #208
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
| name: Documentation | |
| 'on': | |
| push: | |
| branches: | |
| - main | |
| pull_request: {} | |
| workflow_dispatch: {} | |
| defaults: | |
| run: | |
| shell: bash -el {0} | |
| concurrency: | |
| group: doc-${{github.ref}} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| name: Build documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: 🛒 Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - id: setup-env | |
| name: 📦 Set up Conda environment | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: docs/environment.yml | |
| environment-name: lkpy | |
| init-shell: bash | |
| cache-environment: true | |
| - id: install | |
| name: 🍱 Install LensKit packages | |
| run: | | |
| pip install --no-deps -e lenskit -e lenskit-funksvd -e lenskit-implicit | |
| - id: docs | |
| name: 📚 Build documentation site | |
| run: | | |
| just docs | |
| - name: 📤 Package documentation site | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: lenskit-docs | |
| path: build/doc | |
| archive: | |
| name: Archive documentation | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build | |
| if: github.event_name == 'push' || github.event_name == 'release' | |
| environment: docs | |
| steps: | |
| - name: 🛒 Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 1 | |
| - name: Check out doc site | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: lenskit/lenskit-docs | |
| ssh-key: ${{ secrets.DOC_DEPLOY_KEY }} | |
| path: doc-site | |
| ref: version/latest | |
| - name: 📥 Fetch documentation package | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: lenskit-docs | |
| path: build/doc | |
| - name: 🛻 Copy documentation content | |
| run: | | |
| rsync -av --delete --exclude=.git/ --exclude=.buildinfo --exclude=.doctrees \ | |
| build/doc/ doc-site/ | |
| cd doc-site | |
| git config user.name "LensKit Doc Bot" | |
| git config user.email "[email protected]" | |
| git add . | |
| git commit -m 'rebuild documentation' | |
| - name: 🛫 Push documentation | |
| run: cd doc-site && git push | |
| publish: | |
| name: Publish documentation | |
| runs-on: ubuntu-latest | |
| needs: | |
| - archive | |
| if: github.event_name == 'push' || github.event_name == 'release' | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Check out doc site | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: lenskit/lenskit-docs | |
| ref: main | |
| fetch-depth: 0 | |
| - name: 🌳 Fix local git branches | |
| run: | | |
| for branch in $(git branch -r --list 'origin/version/*'); do | |
| git branch -t ${branch##origin/} $branch | |
| done | |
| git branch -a | |
| - name: 🛸 Set up Deno | |
| uses: denoland/setup-deno@v1 | |
| with: | |
| deno-version: ~1.44 | |
| - name: 🧛🏼 Set up Just | |
| uses: extractions/setup-just@v2 | |
| - name: Build site content | |
| run: just build | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: 📦 Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| - name: 🕸️ Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |