diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..216e1ea --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,55 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Docs +on: [push] + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +jobs: + # Single deploy job since we're just deploying + deploy: + name: Deploy Documentation + + # 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: Checkout repo + uses: actions/checkout@v4 + + - name: Install pnpm package manager + uses: pnpm/action-setup@v4 + with: + version: 9.10.0 + + - name: Use Node ${{ matrix.node }} + uses: actions/setup-node@v4 + with: + cache: 'pnpm' + + - name: TSDoc Action + uses: erikyo/tsdoc-action@v1 + with: + source_dir: ./src/index.ts + output_dir: ./docs + front_page: README.md + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + # Upload entire repository + path: './docs' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2