docs(autojac): Document Transforms (#326)
#62
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]*' | |
| 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@v4 | |
| - name: Setup PDM | |
| uses: pdm-project/setup-pdm@v4 | |
| with: | |
| python-version: '3.13' | |
| - name: Install dependencies (default & doc) | |
| run: pdm install --group doc --frozen-lockfile | |
| - 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: pdm run make dirhtml | |
| env: | |
| TORCHJD_VERSION: ${{ steps.deploy_folder.outputs.TORCHJD_VERSION }} | |
| - name: Deploy to DEPLOY_DIR of 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: 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 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: 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 |