funkysi1701/Signal Diff Crawl

Trigger a Signal Diff crawl, wait for completion, and optionally fail by policy.

View on GitHub

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Jun 13, 2026
License: None

Pinned Snippet

workflow.ymlSHA-pinned

uses: funkysi1701/signal-diff-action@be3d22af5f6cd5005380828c06329a07dc12495f # v1.9

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

Inputs

name	description	required	default
api_base_url	Base URL of the Signal Diff API host.	yes	—
api_key	Signal Diff CI API key.	yes	—
sitemap_url	Sitemap URL to crawl.	yes	—
fail_mode	Failure policy: none, error, or errorOrWarning.	no	error
execution_mode	Crawl execution route: cloud (Signal Diff hosted) or agent (customer agent pool).	no	cloud
agent_pool_id	Agent pool id when execution_mode is agent (must match enrolled agent; omit for default pool).	no	""
comment_on_pr	Post a crawl summary comment on PRs.	no	false
github_token	GitHub token for PR comments and code-change collection (contents: read).	no	${{ github.token }}
collect_code_changes	After crawl completes, summarize git changes and PATCH to Signal Diff.	no	true
max_changed_files	Maximum changed file paths to include in the CI code change summary.	no	50
max_new_findings_in_comment	Maximum new run-diff findings listed in the PR comment.	no	5
risk_score_enabled	Include rule-based risk score in PR comment.	no	true
baseline_ref	Optional baseline commit SHA for push/workflow_dispatch (overrides last-run API).	no	""
repository	Repository slug (owner/repo).	no	${{ github.repository }}
ref_name	Git ref for this run.	no	${{ github.ref }}
commit_sha	Commit SHA for this run.	no	${{ github.sha }}
workflow_run_id	GitHub workflow run ID.	no	${{ github.run_id }}
workflow_run_url	GitHub workflow run URL.	no	${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
pull_request_number	PR number associated with this run.	no	${{ github.event.pull_request.number \|\| '' }}
inline_annotations	Post inline PR comments on high-risk changed files.	no	false
annotation_max_files	Maximum files to annotate inline.	no	3

Outputs

name	description
job_id	Signal Diff job ID.
trigger_url	Resolved trigger endpoint URL used to start the crawl.
status_url	Status URL for the crawl job.
status	Final crawl status.
errors	Final crawl error count.
warnings	Final crawl warning count.
pages	Final crawled page count.
code_changes_collected	Whether a CI code change summary was attached to the job.