Skip to content

Commit

Permalink
Add github workflow for docs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
xaviablaza committed Feb 15, 2024
1 parent 63a3c95 commit 89143e6
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Crystal Docs Generation

on:
push:
branches: [ "main" ]
# 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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/setup-node@v4
with:
node-version: 20.x
- uses: crystal-lang/install-crystal@v1
with:
crystal: 1.6.2
- uses: actions/checkout@v4
- name: Generate docs
run: crystal docs
- name: Move docs to _site
run: mv docs/ _site/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 89143e6

Please sign in to comment.