busbar-actions/Busbar Metadata Pull

Retrieve Salesforce metadata into the repo as a source-format tree (or MDAPI zip)

Trust Signals

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

Pinned Snippet

workflow.ymlSHA-pinned

uses: busbar-actions/sf-metadata-retrieve@53e994ac1ef000c1df5c889394458917bf8b0840 # no releases — HEAD as of 2026-07-11

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

Inputs

name	description	required	default
target-instance	Instance URL of the Busbar-equipped Salesforce org to authenticate to, e.g. https://yourdomain.my.salesforce.com. This is the DEFAULT auth path: the binary mints its OWN short-lived token in-process from the runner's GitHub OIDC id-token (no SF token ever touches the workflow). Requires the caller job to grant `permissions: id-token: write`.	no	""
target	Where the retrieved metadata is written, relative to the repo root.	no	force-app/main/default
package-xml	Path to a package.xml manifest. If omitted, types/components drive the retrieve scope.	no	""
types	Comma-separated metadata type names to retrieve (e.g. CustomObject,ApexClass,Flow).	no	""
components	Comma-separated Type:Name component refs (e.g. CustomObject:Account,ApexClass:OrderUtil).	no	""
api-version	Metadata API version to target. Empty = use the org default.	no	""
emit-manifest	Write the resolved package.xml the retrieve actually used into the target.	no	true
manifest-path	Relative-to-target filename for the emitted manifest.	no	package.xml
commit	Commit retrieved metadata back to the current branch.	no	true
commit-message	Commit message used when commit=true.	no	chore(metadata): refresh Salesforce metadata
git-user-name	git user.name for the commit.	no	busbar-bot
git-user-email	git user.email for the commit.	no	bot@busbar.agency
comment-pr	Post a summary comment on pull_request events.	no	true
upload-artifact	Upload retrieved metadata as a workflow artifact.	no	false
artifact-name	Artifact name when upload-artifact=true.	no	metadata
version	Release tag of the sf-metadata-retrieve binary. Falls back to env.BUSBAR_ACTION_VERSION, then "latest".	no	""
binary-repo	GitHub repo hosting prebuilt binary releases. Falls back to env.BUSBAR_ACTION_REPO, then busbar-actions/actions-dist.	no	""

Outputs

name	description
changed	"true" if the pull produced changes vs the prior tree.
target-path	Path where metadata was written (echoes the input).
manifest-path	Path to the emitted manifest (empty if emit-manifest=false).
component-count	Number of components retrieved.
file-count	Number of files written to the target tree.