Merge pull request #1233 from esthertitilayo-dev/fix/1150-introduce-s… #44

	name: Deploy Documentation

	on:
	push:
	branches:
	- main
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- 'requirements.txt'
	- '.github/workflows/docs-deploy.yml'
	workflow_dispatch:

	permissions:
	contents: write

	jobs:
	deploy:
	runs-on: ubuntu-latest
	timeout-minutes: 15
	steps:
	- name: Checkout repository
	uses: actions/checkout@v7
	with:
	fetch-depth: 0 # Fetch all history for git-revision-date-localized

	- name: Set up Python
	uses: actions/setup-python@v6
	with:
	python-version: '3.11'
	cache: 'pip'

	- name: Install dependencies
	run: \|
	pip install --upgrade pip
	pip install -r requirements.txt

	- name: Set up Rust (for cargo doc)
	uses: ./.github/actions/setup-rust
	with:
	cache-key: "docs-deploy"

	- name: Generate Rust API documentation
	# Issue #1138: RUSTDOCFLAGS=-D warnings turns any rustdoc warning into
	# a hard error so that documentation quality is enforced in CI.
	# The continue-on-error guard has been removed — broken docs must be
	# fixed before they are published to the docs site.
	run: \|
	RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --document-private-items

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

	- name: Build and deploy documentation
	run: \|
	mkdocs gh-deploy --force --clean --verbose

	- name: Verify deployment
	run: \|
	echo "Documentation deployed successfully!"
	echo "Site should be available at: https://m1s0g1.github.io/Stellar-K8s/"

Navigation Menu