feat: advanced usage #42
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: Deploy GitHub Pages | |
| on: | |
| workflow_dispatch: | |
| push: | |
| paths: | |
| - 'docs/**' | |
| branches: | |
| - "main" | |
| # 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, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Not needed if lastUpdated is not enabled | |
| # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm | |
| # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Install dependencies | |
| working-directory: ./docs | |
| run: npm install | |
| - name: Build with VitePress | |
| run: | | |
| npm run --prefix docs build | |
| mkdir staging | |
| cp ./docs/.vitepress/dist/* staging -r | |
| - uses: actions/setup-java@v3 | |
| with: | |
| java-version: '11' | |
| distribution: 'temurin' | |
| java-package: 'jdk' | |
| cache: 'maven' | |
| server-id: ossrh | |
| - name: Release With Maven | |
| run: | | |
| mvn javadoc:javadoc | |
| mkdir staging/javadoc | |
| cp target/site/apidocs/* staging/javadoc -r | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: staging | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| name: Deploy | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |