Deploy documentation to Pages #1
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
# Deploy AsciiDoc documentation to GitHub Pages | |
name: Deploy documentation to Pages | |
on: | |
# Runs on pushes targeting the default branch | |
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 one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
# Build and publish the documentation | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
container: asciidoctor/docker-asciidoctor | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
# The asciidoctor container is built on Alpine and contains only a Busybox tar. | |
# Github Actions need GNU tar for its options. | |
- name: Install tar | |
run: apk add tar | |
- name: Build documentation | |
run: asciidoctor --safe -vn docs/main.adoc --out-file=docs/index.html | |
- name: Setup Pages | |
uses: actions/configure-pages@v2 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
# Upload the generated HTML file | |
path: 'docs' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |