tuftsrt/sphinx-to-branch

build sphinx documentation and push results to gh-pages

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
source-branch	Branch to build documentation from. Defaults to the triggering branch	no	${{ github.ref_name }}
destination-branch	Branch to push built the documentation to. Defaults to `gh-pages` branch.	no	gh-pages
clear-destination	Whether to delete all files from the destination branch before building. Must be set to "true" for deletion to occur. Other values ignored.	no	false
keep-items	Newline-delimited list of glob patterns to keep when destination branch set to be cleared. Ignored if destination branch not set to be cleared.	no	CNAME
remove-items	Newline-delimited list of glob patters to delete from the destination branch before building. Ignored if destination branch set to be cleared.	no	""
source-directory	Directory on source branch containing documentation source files. Defaults to repository root.	no	""
destination-directory	Directory on destination branch to push the built documentation to. Defaults to repository root.	no	""
environment-file	Conda environment YML file on source branch to install dependencies from. Must contain Sphinx and any other build dependencies. Defaults to `environment.yaml` in repository root.	no	environment.yaml
build-command	Command to build the documentation. Uses `sphinx-build` if omitted.	no	sphinx-build
build-arguments	Additional optional arguments to pass to the build command.	no	""
add-nojekyll	Whether to add a `.nojekyll` file to the root of the destination branch. Must be set to "true" for the file to be added. Other values ignored.	no	true
commit-message	Message to use when committing built documentation to destination branch. Defaults to the SHA of the triggering commit.	no	${{ github.sha }}
use-bot	Whether to use the github-actions[bot] account to commit and push changes. Must be set to "true" for the bot to be used. Other values ignored. (Author of the last commit on the source branch used by default.)	no	false
dry-run	Whether to run the action without pushing to the destination branch. Must be set to "true" for dry run to occur. Other values ignored. Can be used as a pull request status check confirming a successful build. (Destination branch will need to be cleared to ensure a clean build.)	no	false
use-expect	Whether to use `expect` to perform actions based on build console output. Must be set to "true" for `expect` to be used. Other values ignored.	no	false
expect-timeout	Number of seconds `expect` will wait for the build to complete. Must be an integer. Defaults to `-1`, which disables the timeout. Exceeding the time limit causes the build to quit and exit with success. Use `expect-pattern-action` to configure an alternate timeout behavior.	no	-1
expect-pattern-action	Pattern-action pairs passed to `expect` when monitoring console output. See `man expect` and action README for examples and syntax details. Any timeout action must be specified here using the `timeout` pattern. Variable `$EXPECT_TIMEOUT` (value of `expect-timeout`) available for use.	no	""

Outputs

no outputs