From 8919a724c4ca70b4867c23c22d959b8ad2fa1789 Mon Sep 17 00:00:00 2001 From: Jeremy Woertink Date: Wed, 16 Jun 2021 10:06:59 -0700 Subject: [PATCH] Adding in a workflow for generating API docs. Fixes #29 (#30) --- .github/workflows/docs.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..39fd171 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,24 @@ +name: Deploy docs + +on: + push: + branches: [master] + +jobs: + deploy: + runs-on: ubuntu-latest + container: + image: crystallang/crystal:0.36.1 + steps: + - uses: actions/checkout@v2 + with: + persist-credentials: false + - name: "Install shards" + run: shards install + - name: "Generate docs" + run: crystal docs + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs