Release 4.5.0-dev.3 #65
Workflow file for this run
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
| # Simple workflow for deploying static content to GitHub Pages | |
| name: TypeDoc | |
| on: | |
| # Runs on new releases | |
| release: | |
| types: [published] | |
| push: | |
| branches: [main] | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # Single deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v4 | |
| - name: Setup | |
| uses: ./.github/actions/setup | |
| - name: Build TypeDoc | |
| run: yarn doc | |
| - name: Zip It Up 🤐 | |
| run: | | |
| zip -r react-native-agora-docs.zip docs | |
| - name: Upload Artifact ⬆️ | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: react-native-agora-docs.zip | |
| path: react-native-agora-docs.zip | |
| if-no-files-found: error | |
| - name: Upload Doc Archive to GitHub release ⬆️ | |
| if: github.event.release | |
| uses: svenstaro/upload-release-action@2.6.0 | |
| with: | |
| file: react-native-agora-docs.zip | |
| asset_name: react-native-agora-docs.zip | |
| tag: ${{ github.ref_name }} | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| # Upload docs directory | |
| path: 'docs' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |