breaking: remove deprecated behavior #943
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: | |
| release: | |
| types: [released] | |
| pull_request: | |
| branches: ["main"] | |
| workflow_dispatch: | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone repo | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Clone docs repo | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| repository: Nixtla/docs | |
| ref: scripts | |
| path: docs-scripts | |
| - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| with: | |
| python-version: '3.10' | |
| cache-dependency-path: settings.ini | |
| - name: Install dependencies | |
| run: pip install uv && uv pip install ".[dev]" --system | |
| - name: Build docs | |
| run: | | |
| mkdir nbs/_extensions | |
| cp -r docs-scripts/mintlify/ nbs/_extensions/ | |
| python docs-scripts/update-quarto.py | |
| nbdev_docs | |
| - name: Apply final formats | |
| run: bash ./docs-scripts/docs-final-formatting.bash | |
| - name: Copy over necessary assets | |
| run: cp nbs/mint.json _docs/mint.json && cp docs-scripts/imgs/* _docs/ | |
| - name: Deploy to Mintlify Docs | |
| if: | | |
| github.event_name == 'release' || | |
| github.event_name == 'workflow_dispatch' | |
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: docs | |
| publish_dir: ./_docs | |
| user_name: github-actions[bot] | |
| user_email: 41898282+github-actions[bot]@users.noreply.github.com | |
| - name: Trigger mintlify workflow | |
| if: | | |
| github.event_name == 'release' || | |
| github.event_name == 'workflow_dispatch' | |
| uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 | |
| with: | |
| github-token: ${{ secrets.DOCS_WORKFLOW_TOKEN }} | |
| script: | | |
| await github.rest.actions.createWorkflowDispatch({ | |
| owner: 'nixtla', | |
| repo: 'docs', | |
| workflow_id: 'mintlify-action.yml', | |
| ref: 'main', | |
| }); | |
| - name: Configure redirects for gh-pages | |
| run: python docs-scripts/configure-redirects.py neuralforecast | |
| - name: Deploy to Github Pages | |
| if: | | |
| github.event_name == 'release' || | |
| github.event_name == 'workflow_dispatch' | |
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: ./gh-pages | |
| user_name: github-actions[bot] | |
| user_email: 41898282+github-actions[bot]@users.noreply.github.com |