Skip to content

Update Documentation #61

Update Documentation

Update Documentation #61

Workflow file for this run

# Workflow for updating the documentation website
---
name: Update Documentation
# Documentation updates can happen in different ways; allow only one at a time
concurrency: release
on:
# Allow running this workflow manually from the Actions tab
workflow_dispatch:
push:
branches:
- main
jobs:
Update-Documentation:
name: Update the documentation
runs-on: ubuntu-latest
steps:
- name: Checkout the repo
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
submodules: true
# This GPG key is for the `phylum-bot` account and used in order to ensure commits are signed/verified
# It is also required for the push to the `gh-pages` branch since GitHub removed support for password
# authentication on August 13, 2021 and the Docusaurus deploy command uses passwords (or PATs) by default.
- name: Import GPG key for bot account
uses: crazy-max/ghaction-import-gpg@82a020f1f7f605c65dd2449b392a52c3fcfef7ef # v6.0.0
with:
gpg_private_key: ${{ secrets.PHYLUM_BOT_GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PHYLUM_BOT_GPG_PASSPHRASE }}
git_user_signingkey: true
git_commit_gpgsign: true
- name: Install local website package
working-directory: ./site
run: npm ci
- name: Build documentation website
working-directory: ./site
run: npm run build
- name: Deploy documentation website
working-directory: ./site
env:
USE_SSH: true
# GIT_USER: 'phylum-bot'
# GIT_PASS: ${{ secrets.GH_RELEASE_PAT }}
GIT_USER_NAME: 'phylum-bot'
GIT_USER_EMAIL: '[email protected]'
run: npm run deploy