Update getting started section #5
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: docs | |
on: | |
push: | |
branches: | |
- main | |
env: | |
SITE_DIR: "gh-pages" | |
jobs: | |
build_site: | |
name: "Build site with Antora" | |
runs-on: [ubuntu-latest] | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v2 | |
- name: "Generate site using antora site action" | |
uses: kameshsampath/antora-site-action@master | |
with: | |
antora_playbook: site.yml | |
- name: "Upload generated site" | |
uses: actions/upload-artifact@@v4 | |
with: | |
name: site | |
path: "${{ github.workspace }}/${{ env.SITE_DIR }}" | |
deploy_site: | |
runs-on: [ubuntu-latest] | |
needs: [build_site] | |
name: "Deploy GitHub Pages" | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v2 | |
- name: Download generated site | |
uses: actions/download-artifact@v1 | |
with: | |
name: site | |
path: "${{ github.workspace }}/${{ env.SITE_DIR }}" | |
- name: Deploy to GitHub Pages | |
uses: JamesIves/github-pages-deploy-action@3.2.1 | |
with: | |
# ACCESS_TOKEN: # optional | |
GITHUB_TOKEN: "${{ github.token}}" | |
FOLDER: "${{ env.SITE_DIR }}" | |
BRANCH: "gh-pages" | |
COMMIT_MESSAGE: "[CI] Publish Documentation for ${{ github.sha }}" |