Docs

Pre-release v3.0.0-B0351 (#2672) #405

	#
	# Build documentation site
	#

	# NOTES:
	# This workflow generates and published the documentation site https://microsoft.github.io/PSRule/.

	name: Docs
	on:
	push:
	branches:
	- main
	workflow_dispatch:

	permissions: {}

	jobs:
	publish:
	name: Publish docs
	runs-on: ubuntu-latest
	permissions:
	contents: write
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	with:
	fetch-depth: 0

	- name: Configure
	run: \|
	git config user.name github-actions
	git config user.email '41898282+github-actions[bot]@users.noreply.github.com'

	- name: Setup Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.11'
	architecture: 'x64'

	- name: Install dependencies
	run: \|
	python3 -m pip install --upgrade pip
	python3 -m pip install wheel
	python3 -m pip install -r requirements-docs.txt

	- name: Generate site
	run: mike deploy --push --update-aliases v3 latest --title 'v3'
	env:
	MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}

	deploy:
	name: Deploy pages
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: [publish]
	concurrency:
	group: pages
	cancel-in-progress: false
	permissions:
	contents: read
	pages: write
	id-token: write
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	with:
	ref: refs/heads/gh-pages

	- name: Setup Pages
	uses: actions/configure-pages@v5

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: '.'

	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback