Skip to content

Commit

Permalink
Adding in a workflow for generating API docs. Fixes #29 (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
jwoertink authored Jun 16, 2021
1 parent 9792723 commit 8919a72
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8919a72

Please sign in to comment.