Chain Abstraction Documentation (#406) #97
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: framwork-gh-pages-deploy | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - "framework/docs/**" | |
| tags: | |
| - "v[0-9]+.[0-9]+.[0-9]+" # Push events to matching v*, i.e. v1.0, v20.15.10 | |
| - "v[0-9]+.[0-9]+.[0-9]+-rc*" # Push events to matching v*, i.e. v1.0-rc1, v20.15.10-rc5 | |
| - "v[0-9]+.[0-9]+.[0-9]+-beta*" # Push events to matching v*, i.e. v1.0-rc1, v20.15.10-rc5 | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎 | |
| uses: actions/checkout@v3 | |
| - name: Setup | Rust | |
| id: rustup | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Setup | Just | |
| id: just | |
| uses: extractions/setup-just@v1 | |
| - name: Install static-sitemap-cli | |
| run: npm install static-sitemap-cli | |
| - name: Install dependencies 🔧 | |
| working-directory: ./framework | |
| run: just docs-install | |
| - name: Build 🏗️ | |
| working-directory: ./framework | |
| run: just docs-build | |
| - name: Generate sitemap | |
| run: | | |
| cd framework/docs/book | |
| npx sscli --no-clean --base https://docs.abstract.money | |
| - name: Upload artifact | |
| if: ${{ github.event_name != 'pull_request' }} | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| # Upload book repository | |
| path: './framework/docs/book' | |
| # Deploy job | |
| deploy: | |
| if: ${{ github.event_name != 'pull_request' }} | |
| # Add a dependency to the build job | |
| needs: build | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| # Deploy to the github-pages environment | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| # Specify runner + deployment step | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |