Docs

chore(deps): pin re-actors/alls-green action to 05ac938 #95

	name: Docs

	on:
	# Runs on pushes targeting the default branch
	push:
	branches: [main]
	pull_request:
	paths:
	- docs/**
	- .github/workflows/docs.yml
	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Allow one concurrent deployment
	concurrency:
	group: pages
	cancel-in-progress: true

	jobs:
	docs:
	runs-on: ubuntu-latest
	defaults:
	run:
	shell: bash -el {0}
	steps:
	- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

	- uses: conda-incubator/setup-miniconda@fc2d68f6413eb2d87b895e92f8584b5b94a10167 # v3.3.0
	with:
	activate-environment: conda-anaconda-telemetry-docs
	environment-file: docs/environment.yml
	python-version: '3.12'
	auto-activate-base: false

	- name: Build Documentation
	run: \|
	cd docs
	make dirhtml

	- name: Upload artifact
	uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
	with:
	# Upload entire repository
	path: docs/_build/dirhtml

	pages:
	runs-on: ubuntu-latest
	if: github.ref == 'refs/heads/main'
	needs: [docs]

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

	status-check:
	name: Check all tests passed
	if: always()
	needs:
	- docs
	runs-on: ubuntu-latest
	steps:
	- uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # release/v1
	with:
	jobs: ${{ toJSON(needs) }}

Navigation Menu