chore: Switch to SimplexLab organization (#504) #228
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: Build and Deploy Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| tags: | |
| - 'v[0-9]*.[0-9]*.[0-9]*' | |
| env: | |
| UV_NO_SYNC: 1 | |
| jobs: | |
| build-deploy-doc: | |
| name: Build & deploy doc | |
| environment: prod-documentation | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: '3.14' | |
| - uses: ./.github/actions/install-deps | |
| with: | |
| groups: doc | |
| - name: Determine deployment folder | |
| id: deploy_folder | |
| run: | | |
| echo "Determining deployment folder..." | |
| if [[ "${{ github.ref }}" == refs/tags/* ]]; then | |
| echo "Deploying to target ${{ github.ref_name }}" | |
| echo "DEPLOY_DIR=${{ github.ref_name }}" >> $GITHUB_OUTPUT | |
| echo "TORCHJD_VERSION=${{ github.ref_name }}" >> $GITHUB_OUTPUT | |
| else | |
| echo "Deploying to target latest" | |
| echo "DEPLOY_DIR=latest" >> $GITHUB_OUTPUT | |
| echo "TORCHJD_VERSION=main" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Build Documentation | |
| working-directory: docs | |
| run: uv run make dirhtml | |
| env: | |
| TORCHJD_VERSION: ${{ steps.deploy_folder.outputs.TORCHJD_VERSION }} | |
| - name: Deploy to DEPLOY_DIR of SimplexLab/TorchJD-documentation | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| deploy_key: ${{ secrets.PROD_DOCUMENTATION_DEPLOY_KEY }} | |
| publish_dir: docs/build/dirhtml | |
| destination_dir: ${{ steps.deploy_folder.outputs.DEPLOY_DIR }} | |
| external_repository: SimplexLab/TorchJD-documentation | |
| publish_branch: main | |
| - name: Kill ssh-agent | |
| # See: https://github.com/peaceiris/actions-gh-pages/issues/909 | |
| run: killall ssh-agent | |
| - name: Deploy to stable of SimplexLab/TorchJD-documentation | |
| if: startsWith(github.ref, 'refs/tags/') | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| deploy_key: ${{ secrets.PROD_DOCUMENTATION_DEPLOY_KEY }} | |
| publish_dir: docs/build/dirhtml | |
| destination_dir: stable | |
| external_repository: SimplexLab/TorchJD-documentation | |
| publish_branch: main | |
| - name: Add documentation link to summary | |
| run: | | |
| echo "### 📄 [View Deployed Documentation](https://torchjd.github.io/documentation/${{ steps.deploy_folder.outputs.DEPLOY_DIR }})" >> $GITHUB_STEP_SUMMARY |