Skip to content

fix(ui): VCS icons from edit/URL, drop mast bullet; generic code icon #62

fix(ui): VCS icons from edit/URL, drop mast bullet; generic code icon

fix(ui): VCS icons from edit/URL, drop mast bullet; generic code icon #62

name: Build and Deploy Documentation
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
strategy:
matrix:
node-version: [20]
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v5
- name: Configure Pages
uses: actions/configure-pages@v5
- name: Install pnpm
uses: pnpm/action-setup/@v4
with:
version: 10
package_json_file: "package.json"
- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v5
with:
node-version: ${{ matrix.node-version }}
cache: "pnpm"
cache-dependency-path: "pnpm-lock.yaml"
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Build Antora site
env:
# Antora requires git credentials to be stored in GIT_CREDENTIALS environment variable
# When Antora tries to access a private GitHub repository, it has to make a call to
# using the standard URL format:
# https://<username>:<password>@github.com
# and GitHub specifies using "x-access-token" as the username. For the password,
# we use the Personal Access Token (PAT) saved into the repository's Secrets manager on
# GitHub. In this case, secrets.FTN_GITHUB_TOKEN_ANTORADOCS
GIT_CREDENTIALS: "https://x-access-token:${{ secrets.FTN_GITHUB_TOKEN }}@github.com"
run: pnpm exec antora --stacktrace antora-playbook.yml
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build/site
publish_branch: gh-pages
commit_message: ${{ github.event.head_commit.message }}