Rust

ci: Reject if documentation builds with warnings #729

	on:
	push:
	branches:
	- master
	pull_request:
	branches:
	- master

	name: Rust

	jobs:
	runner-matrix:
	name: format, lint, test
	strategy:
	fail-fast: false
	matrix:
	os: [ ubuntu-latest, windows-latest, macos-latest ]
	runs-on: ${{ matrix.os }}
	steps:
	- name: Checkout sources
	uses: actions/checkout@v4

	- name: Install stable toolchain
	uses: dtolnay/rust-toolchain@stable
	with:
	components: rustfmt, clippy

	- name: Install nextest
	uses: taiki-e/install-action@nextest

	- name: Run cargo fmt
	run: cargo fmt --all -- --check

	- name: Build documentation
	run: cargo doc --no-deps --workspace
	env:
	RUSTDOCFLAGS: -D warnings

	- name: Run clippy
	run: cargo clippy --all-targets -- -D warnings

	- name: Run tests without benches
	run: >
	cargo nextest run
	--all-targets
	--
	--skip benches
	--skip mine_20_blocks_in_40_seconds
	--skip hash_rate_independent_of_tx_size

	# doctests are special [^1] but this step does not incur a performance penalty [^2]
	#
	# [^1]: https://nexte.st/book/usage.html#limitations
	# [^2]: https://github.com/nextest-rs/nextest/issues/16
	- name: Run documentation tests
	run: cargo test --doc

Provide feedback