Add some more docs & examples to the on-chain bits. #10
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: Continuous Integration | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: ["main"] | |
| tags: ["*.*.*"] | |
| pull_request: | |
| branches: ["main"] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: 📥 Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: 🧰 Setup Pages | |
| uses: actions/configure-pages@v2 | |
| - name: 🧰 Install Aiken | |
| uses: aiken-lang/setup-aiken@v0.1.0 | |
| with: | |
| version: v1.0.26-alpha | |
| - name: 📝 Run fmt | |
| working-directory: on-chain | |
| run: aiken fmt --check | |
| - name: 🔬 Run tests | |
| working-directory: on-chain | |
| run: aiken check | |
| - name: 📘 Generate documentation | |
| shell: bash | |
| working-directory: on-chain | |
| run: aiken docs -o docs | |
| - name: 📦 Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: "on-chain/docs/" | |
| deploy: | |
| if: ${{ github.event_name == 'push' }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: 🚀 Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 |