conjikidow/Typst PDF Diff Action

Build and diff Typst PDFs in GitHub Actions with artifact uploads.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Jul 11, 2026
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: conjikidow/typst-pdf-diff-action@8e68a5cec6004d3c4371e72da164e99760b50ffb # v0.2.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
target-files	Space-separated Typst entrypoint files to compile.	yes	—
typst-version	The Typst version to install.	no	latest
github-token	The GitHub token for checkout, artifact upload, and optional comment updates.	no	${{ github.token }}
submodules	Submodule mode passed to actions/checkout. Use false, true, or recursive.	no	false
head-ref	The head revision to compare. Defaults to the pull request head SHA or github.sha.	no	""
base-ref	The base revision to compare. Defaults to the merge-base of the pull request or github.event.before.	no	""
post-comment	Whether to update a pull request comment with diff results.	no	true
comment-mode	Comment update mode. Supported values are replace and append.	no	replace
fail-on-comment-error	Whether to fail the action when comment updates fail.	no	false
upload-artifacts	Whether to upload head and diff PDFs as workflow artifacts.	no	true

Outputs

name	description
has-diff	`true` when at least one target file has a PDF diff.
head-artifact-url	The uploaded head PDF artifact URL when artifact upload is enabled.
diff-artifact-url	The uploaded diff PDF artifact URL when a diff artifact is uploaded.