docs

dist: cut a new release #694

	name: docs

	on:
	pull_request:
	push:
	branches:
	- master

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

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

	env:
	CARGO_TERM_COLOR: always
	CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: Swatinem/rust-cache@v2
	- uses: dtolnay/rust-toolchain@nightly
	- name: Create
	run: cargo doc --all-features --document-private-items --no-deps
	# https://dev.to/deciduously/prepare-your-rust-api-docs-for-github-pages-2n5i
	- name: Patch `index.html`
	run: \|
	echo '<meta http-equiv="refresh" content="0; url=pacaptr/index.html">' > ./target/doc/index.html
	# https://github.com/actions/upload-pages-artifact#example-permissions-fix-for-linux
	- name: Fix permissions
	run: \|
	chmod -c -R +rX "./target/doc" \| while read line; do
	echo "::warning title=Invalid file permissions automatically fixed::$line"
	done
	- name: Upload artifact
	if: github.event_name == 'push'
	uses: actions/upload-pages-artifact@v3
	with:
	path: ./target/doc

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	if: github.event_name == 'push'
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback