📚 Deploy Documentation #3
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
| # This workflow deploys the Thunder documentation to GitHub Pages | |
| # Uses: | |
| # OS: ubuntu-latest | |
| # Node.js: lts/* | |
| name: 📚 Deploy Documentation | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| use-artifact: | |
| description: 'Use pre-built docs from artifact (leave empty to build from source)' | |
| required: false | |
| type: string | |
| default: '' | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| deploy-docs: | |
| name: 📚 Deploy Docs to GitHub Pages | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: 📥 Checkout Code | |
| uses: actions/checkout@v4 | |
| - name: 📚 Deploy Documentation | |
| uses: ./.github/actions/deploy-docs | |
| with: | |
| docs-artifact-name: ${{ inputs.use-artifact }} | |
| build-docs: ${{ inputs.use-artifact == '' && 'true' || 'false' }} | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: 🎉 Deployment Complete | |
| run: | | |
| echo "# 📚 Documentation Deployment" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Documentation has been successfully deployed to GitHub Pages!" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "🔗 View the documentation at: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/" >> $GITHUB_STEP_SUMMARY |