Skip to content
Build and deploy gh-pages branch with Mkdocs

Fix some formatting in Registry for generating docs #60

Sign in to view logs

Fix some formatting in Registry for generating docs

Fix some formatting in Registry for generating docs #60

Workflow file for this run

.github/workflows/e3sm-gh-pages.yml at 60cfa2d
name: Build and deploy gh-pages branch with Mkdocs
on:
# Runs every time master branch is updated
push:
branches: ["master"]
# Runs every time a PR is open against master
pull_request:
branches: ["master"]
workflow_dispatch:
concurrency:
# Prevent 2+ copies of this workflow from running concurrently
group: e3sm-docs-action
jobs:
Build-and-Deploy-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
show-progress: false
fetch-depth: 0 # Needed, or else gh-pages won't be fetched, and push rejected
submodules: false # speeds up clone and not building anything in submodules
- name: Show action trigger
run: echo "= The job was automatically triggered by a ${{github.event_name}} event."
- name: Set up Python 3.10
uses: actions/setup-python@v4.7.0
with:
python-version: "3.10"
- name: Install python deps
run: python3 -m pip install mkdocs-material pymdown-extensions mkdocs-monorepo-plugin mdutils mkdocs-bibtex
# build every time (PR or push to master)
- name: Build
run: mkdocs build --strict --verbose
# Only deploy to the main github page when there is a push to master
- if: ${{ github.event_name == 'push' }}
name: GitHub Pages action
uses: JamesIves/github-pages-deploy-action@v4
with:
# Do not remove existing pr-preview pages
clean-exclude: pr-preview
folder: ./site/
# If it's a PR from within the same repo, deploy to a preview page
# For security reasons, PRs from forks cannot write into gh-pages for now
- if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository }}
name: Preview docs
uses: rossjrw/pr-preview-action@v1
with:
source-dir: ./site/