This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

[pre-commit.ci] pre-commit suggestions #240

	name: "Deploy Docs"
	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]

	jobs:
	build-docs:
	uses: Lightning-AI/utilities/.github/workflows/[email protected]
	with:
	requirements-file: "requirements/_docs.txt"

	# https://github.com/marketplace/actions/deploy-to-github-pages
	docs-deploy:
	needs: build-docs
	runs-on: ubuntu-latest
	steps:
	- name: Checkout 🛎️
	uses: actions/checkout@v4
	with:
	persist-credentials: false
	- uses: actions/download-artifact@v3
	with:
	name: docs-html-${{ github.sha }}
	path: docs/build/html

	- name: Deploy 🚀
	uses: JamesIves/[email protected]
	if: ${{ github.event_name == 'push' }}
	with:
	token: ${{ secrets.GITHUB_TOKEN }}
	branch: gh-pages # The branch the action should deploy to.
	folder: docs/build/html # The folder the action should deploy.
	clean: true # Automatically remove deleted files from the deploy branch
	target-folder: docs # If you'd like to push the contents of the deployment folder into a specific directory
	single-commit: true # you'd prefer to have a single commit on the deployment branch instead of full history

Provide feedback