Skip to content

Updated main README page, to provide links to documentation and infor… #6

Updated main README page, to provide links to documentation and infor…

Updated main README page, to provide links to documentation and infor… #6

name: Build
on:
push:
branches: [ master, main, develop ]
env:
SITE_DIR: 'site'
jobs:
build_site:
name: "Build site with Antora"
runs-on: [ ubuntu-latest ]
steps:
- name: Checkout
uses: actions/checkout@v2
- name: "Install Node 16"
uses: actions/setup-node@v3
with:
node-version: 16
- name: "Install Antora"
run: make install-antora
- name: "Generate site using antora site action"
run: make build-site
# - name: "Generate site using antora site action"
# uses: kameshsampath/antora-site-action@master
# with:
# antora_playbook: antora-playbook.yml
## site_sources_path: "${{ github.workspace }}build/${{ env.SITE_DIR }}"
## antora_generator: 'antora-site-generator-lunr'
# antora_docsearch_enabled: 'true'
- name: "Upload generated site"
uses: actions/[email protected]
with:
name: site
path: "${{ github.workspace }}/build/${{ env.SITE_DIR }}"
deploy_site:
runs-on: [ ubuntu-latest ]
needs: [ build_site ]
name: "Deploy GitHub Pages"
env:
ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
steps:
- name: "Install Node 16"
uses: actions/setup-node@v3
with:
node-version: 16
- 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/[email protected]
with:
# ACCESS_TOKEN: # optional
GITHUB_TOKEN: "${{ github.token}}"
FOLDER: "${{ env.SITE_DIR }}"
BRANCH: 'gh-pages'
COMMIT_MESSAGE: "[CI] Publish Documentation for ${{ github.sha }}"