Merge pull request #265 from cpaelzer/sru-mitigate-linux-firmware #388

	name: Automatic documentation checks

	on:
	push:
	branches: [ main ]
	pull_request:
	paths:
	- 'docs/**' # Only run on changes to the docs directory
	workflow_call:
	outputs:
	spellcheck-result:
	description: "Result of the spelling check"
	value: ${{ jobs.docchecks.outputs.result_spelling }}
	woke-result:
	description: "Result of the inclusive language check"
	value: ${{ jobs.docchecks.outputs.result_woke }}

	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	jobs:
	docchecks:
	name: Run documentation checks
	runs-on: 'ubuntu-latest'
	outputs:
	result_spelling: ${{ steps.spellcheck-step.outcome }}
	result_woke: ${{ steps.woke-step.outcome }}
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	with:
	fetch-depth: '0'

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.10'

	- name: Spell Check
	id: spellcheck-step
	if: success() \|\| failure()
	uses: canonical/documentation-workflows/spellcheck@main
	with:
	working-directory: 'docs'
	install-target: 'install'
	spelling-target: 'spelling'
	makefile: 'use-default'

	- name: Inclusive Language Check
	id: woke-step
	if: success() \|\| failure()
	uses: canonical/documentation-workflows/inclusive-language@main
	with:
	working-directory: 'docs'
	install-target: 'install'
	woke-target: 'woke'
	makefile: 'use-default'

Provide feedback