Merge branch 'main' of https://github.com/amkrajewski/nimcso #18
Workflow file for this run
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: Generate Documentation | |
| on: | |
| push: | |
| paths: | |
| - src/** | |
| - docs/** | |
| - .github/workflows/documentation.yaml | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| generateDocumentation: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: jiro4989/setup-nim-action@v1 | |
| with: | |
| nim-version: '2.0.2' | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| - run: nimble refresh | |
| - run: nimble install | |
| - name: Build documentation | |
| run: | | |
| nim doc --project --index:on --outdir:docs --git.url:https://github.com/amkrajewski/nimCSO --git.commit:main src/nimcso | |
| cp docs/nimcso.html docs/index.html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'docs' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |