Fix issue with shared state of MetricCollection compute group when …
#74
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: Build Docs | |
| on: | |
| push: | |
| branches: ["master", "release/*"] | |
| tags: ["*"] | |
| pull_request: | |
| branches: ["master", "release/*"] | |
| types: [opened, reopened, ready_for_review, synchronize] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }}-${{ github.head_ref }} | |
| cancel-in-progress: ${{ ! (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release/')) }} | |
| defaults: | |
| run: | |
| shell: bash | |
| env: | |
| FREEZE_REQUIREMENTS: "1" | |
| TORCH_URL: "https://download.pytorch.org/whl/cpu/torch_stable.html" | |
| PYPI_CACHE: "_ci-cache_PyPI" | |
| PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION: "python" | |
| TOKENIZERS_PARALLELISM: false | |
| SPHINX_MOCK_REQUIREMENTS: 0 | |
| SPHINX_FETCH_ASSETS: 0 | |
| SPHINX_PIN_RELEASE_VERSIONS: 1 | |
| jobs: | |
| docs-make: | |
| if: github.event.pull_request.draft == false | |
| runs-on: ubuntu-22.04 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| target: [html, doctest, linkcheck] | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.9" | |
| - name: source cashing | |
| uses: ./.github/actions/pull-caches | |
| with: | |
| pytorch-version: ${{ matrix.pytorch-version }} | |
| pypi-dir: ${{ env.PYPI_CACHE }} | |
| - name: Install package & dependencies | |
| run: | | |
| make get-sphinx-template | |
| # install with -e so the path to source link comes from this project not from the installed package | |
| pip install -e . -U -r requirements/_docs.txt \ | |
| --find-links="${PYPI_CACHE}" --find-links="${TORCH_URL}" | |
| - run: pip list | |
| - name: Full build for deployment | |
| if: github.event_name != 'pull_request' | |
| run: echo "SPHINX_FETCH_ASSETS=1" >> $GITHUB_ENV | |
| - name: Disable Gallery build | |
| if: matrix.target != 'html' | |
| run: echo "SPHINX_ENABLE_GALLERY=0" >> $GITHUB_ENV | |
| - name: make ${{ matrix.target }} | |
| working-directory: ./docs | |
| run: | | |
| pwd | |
| ls -la | |
| make ${{ matrix.target }} --debug --jobs $(nproc) SPHINXOPTS="-W --keep-going" | |
| - name: Upload built docs | |
| if: ${{ matrix.target == 'html' && github.event_name != 'pull_request' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-${{ matrix.target }}-${{ github.sha }} | |
| path: docs/build/ | |
| retention-days: ${{ steps.keep-artifact.outputs.DAYS }} | |
| - name: update cashing | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.target == 'html' }} | |
| continue-on-error: true | |
| uses: ./.github/actions/push-caches | |
| with: | |
| pypi-dir: ${{ env.PYPI_CACHE }} | |
| deploy-docs: | |
| needs: docs-make | |
| if: github.repository_owner == 'Lightning-AI' && github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| env: | |
| GCP_TARGET: "gs://lightning-docs-metrics" | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: docs-html-${{ github.sha }} | |
| path: docs/build/ | |
| - name: Authenticate to Google Cloud | |
| uses: google-github-actions/auth@v2 | |
| with: | |
| credentials_json: ${{ secrets.GCS_SA_KEY }} | |
| - name: Setup gcloud | |
| uses: google-github-actions/setup-gcloud@v2 | |
| with: | |
| project_id: ${{ secrets.GCS_PROJECT }} | |
| # Uploading docs to GCS, so they can be served on lightning.ai | |
| - name: Upload docs/metrics/stable to GCS 🪣 | |
| if: startsWith(github.ref, 'refs/heads/release/') | |
| run: gsutil -m rsync -d -R docs/build/html/ ${GCP_TARGET}/stable | |
| # Uploading docs to GCS, so they can be served on lightning.ai | |
| - name: Upload docs/metrics/latest to GCS 🪣 | |
| if: github.ref == 'refs/heads/master' | |
| run: gsutil -m rsync -d -R docs/build/html/ ${GCP_TARGET}/latest | |
| # Uploading docs to GCS, so they can be served on lightning.ai | |
| - name: Upload docs/metrics/release to GCS 🪣 | |
| if: startsWith(github.ref, 'refs/tags/') | |
| run: gsutil -m rsync -d -R docs/build/html/ ${GCP_TARGET}/${{ github.ref_name }} | |
| # Uploading docs as archive to GCS, so they can be as backup | |
| - name: Upload docs as archive to GCS 🪣 | |
| if: startsWith(github.ref, 'refs/tags/') | |
| working-directory: docs/build | |
| run: | | |
| zip ${{ github.ref_name }}.zip -r html/ | |
| gsutil cp ${{ github.ref_name }}.zip ${GCP_TARGET} |