Repository navigation

Docs

Address connection races (#6867) #45

	name: Docs

	on:
	push:
	branches:
	- main

	permissions:
	contents: read
	pages: write
	id-token: write

	jobs:
	build:
	runs-on: ubuntu-24.04
	env:
	elixir: 1.20.4
	otp: 29.0.5
	steps:
	- name: Checkout
	uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

	- name: Set up Elixir
	uses: erlef/setup-beam@54075bcc5e249e4758d363f27d099f55d843f124 # v1.24.1
	with:
	elixir-version: ${{ env.elixir }}
	otp-version: ${{ env.otp }}

	# the docs alias also builds the JavaScript documentation with npm
	- name: Set up Node.js 24.x
	uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
	with:
	node-version: 24.x

	- name: Restore deps and _build cache
	uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
	with:
	path: \|
	deps
	_build
	key: ${{ runner.os }}-mix-${{ env.elixir }}-${{ env.otp }}-${{ hashFiles('**/mix.lock') }}-docs
	restore-keys: \|
	${{ runner.os }}-mix-${{ env.elixir }}-${{ env.otp }}-
	- name: Install Dependencies
	run: mix deps.get --only docs

	- name: Build docs
	run: mix docs

	- name: Upload artifact
	uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
	with:
	path: doc/

	# Deployment job
	deploy:
	environment:
	name: github-pages
	url: ${{steps.deployment.outputs.page_url}}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1