johntitor/rust-thanks-action

Generate badge URLs and SVG cards from Rust Thanks

Trust Signals

name	description	required	default
name	A name listed in Rust Thanks	yes	—
format	Output format: svg, badge, or both	no	svg
output-path	Where to write the generated SVG when format includes svg	no	rust-thanks-card.svg
avatar-url	Optional avatar image URL to embed in the SVG card	no	""
title	Headline shown in the SVG card	no	Rust Contribution Stats
theme	Card theme: rust, light, or slate	no	rust
commit-message	Commit message used when push-changes is true	no	Update Rust Thanks card
push-changes	Whether to push the generated commit to a remote branch	no	false
push-branch	Branch to push to. Defaults to GITHUB_HEAD_REF or GITHUB_REF_NAME	no	""
remote-name	Git remote name used when push-changes is true	no	origin
github-token	GitHub token used to configure an authenticated push URL	no	${{ github.token }}
git-user-name	Git author name used when push-changes is true	no	github-actions[bot]
git-user-email	Git author email used when push-changes is true	no	41898282+github-actions[bot]@users.noreply.github.com
write-readme	Whether to replace a local README marker block with the generated snippet	no	false
readme-path	README path to update when write-readme is true	no	README.md
readme-marker	Marker name used as START_SECTION/END_SECTION suffix	no	rust-thanks-card

name	description
name	Matched name from Rust Thanks
rank	Numeric rank from Rust Thanks
ordinal-rank	Ordinal rank such as 1st or 42nd
contributions	Contribution count from Rust Thanks
badge-url	Generated shields.io badge URL
committed	Whether this action created a commit
commit-sha	Commit SHA when push-changes created a commit
pushed	Whether this action pushed the generated commit
pushed-ref	Remote ref updated when push-changes succeeds
svg	Generated SVG markup when format includes svg
svg-path	Absolute path to the generated SVG file when format includes svg
readme-snippet	Snippet written into README when write-readme is enabled