1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Deploy AsciiDoc documentation to GitHub Pages
name: Deploy documentation to Pages
on:
# Runs on pushes targeting the default branch
push:
branches:
# 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@v4
# 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@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the generated HTML file
path: 'docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4