add docs preview within PRs #8

	name: E3SM Docs

	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:
	e3sm-docs:
	runs-on: ubuntu-latest
	steps:
	-
	name: Check out code
	uses: actions/checkout@v4
	with:
	show-progress: false
	# We will need submodules when/if we build EAMxx docs here
	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/[email protected]
	with:
	python-version: "3.10"
	-
	name: Install Python deps
	run: python3 -m pip install mkdocs-material pymdown-extensions mkdocs-monorepo-plugin mdutils
	-
	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/

Provide feedback