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: Deploy Documentation to Pages | |
on: | |
push: | |
branches: ["development"] | |
workflow_dispatch: | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
deploy-documentation: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install Vlang dependencies | |
run: sudo apt update && sudo apt install -y libgc-dev | |
- name: Setup Vlang | |
uses: vlang/[email protected] | |
with: | |
check-latest: true | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Generate documentation | |
run: | | |
rm -rf _docs | |
rm -rf docs | |
cd crystallib | |
rm -rf _docs | |
rm -rf docs | |
v fmt -w . | |
v doc -m -f html . -readme -comments -no-timestamp | |
mv _docs ../docs | |
- name: Setup Pages | |
uses: actions/configure-pages@v3 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: "/home/runner/work/crystallib/crystallib/docs" | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |