djoezeke/clang-format-action

Run clang-format diagnostics, optionally apply fixes, and publish review feedback on pull requests.

Trust Signals

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

Inputs

name	description	required	default
github_token	Token used to push the fix branch and create or update a pull request.	yes	—
clang_format_path	Path to the clang-format executable.	no	clang-format
source_extensions	Comma-separated list of source file extensions to analyze.	no	.c,.cc,.cpp,.cxx,.m,.mm,.h,.hh,.hpp,.hxx
exclude_paths	Comma-separated list of path fragments to ignore.	no	.git
format_file	Apply clang-format fixes in place (`-i`) for each analyzed file.	no	true
create_pull_request	Create or update a pull request when formatting changes were applied.	no	true
base_branch	Base branch for the pull request. Defaults to the repository default branch.	no	""
branch_prefix	Prefix for the generated fix branch.	no	clang-format/auto-fix
commit_message	Commit message used when fixes are committed.	no	chore: apply clang-format fixes
pr_title	Title for the pull request.	no	Apply clang-format fixes
pr_body	Optional extra text appended to the generated pull request body.	no	""
thread_comments	Leave an issue-thread report comment on the pull request. Options `update`, `create`, or `off`.	no	update
analysis_scope	Scope of analysis. Use 'all' for all tracked files or 'changed' for files changed in the PR.	no	all
format_review	Create a pull request review when clang-format diagnostics are found.	no	true
review_event	Review event for pull request reviews. Options `comment` or `request_changes`.	no	comment
file_annotations	Create GitHub file annotations for reported diagnostics.	no	true
fail_on_diagnostics	Legacy fail policy. When true, fail if any diagnostics are found.	no	false
max_comments	Maximum inline review comments to post (0 = unlimited).	no	0
suppress_warnings	Suppress clang-format warning-level diagnostics.	no	false
max_diagnostics	Maximum diagnostics included in review/annotation/report surfaces (0 = unlimited).	no	0
fail_on	Failure policy. Options `none`, `error`, or `all`.	no	none

Outputs

name	description
changed	Whether files were modified.
diagnostics	Number of clang-format diagnostics collected.
diagnostics_reported	Number of diagnostics included in report/review output after limits and suppression.
diagnostics_warnings	Number of warning-level diagnostics.
diagnostics_errors	Number of error-level diagnostics.
branch	Name of the generated branch.
pull_request_url	URL of the created or updated pull request.
review_id	ID of the created PR review.
report_path	Path to the generated markdown report.