GitHub FUNDING.yml Sponsorship Config Auditor avatar

GitHub FUNDING.yml Sponsorship Config Auditor

Pricing

Pay per usage

Go to Apify Store
GitHub FUNDING.yml Sponsorship Config Auditor

GitHub FUNDING.yml Sponsorship Config Auditor

Audit a public GitHub repository's .github/FUNDING.yml sponsorship configuration in one API call. Validates every platform key against GitHub's documented syntax, flags unknown keys and oversized lists, and returns a readiness score and grade.

Pricing

Pay per usage

Rating

0.0

(0)

Developer

Sanskar Jaiswal

Sanskar Jaiswal

Maintained by Community

Actor stats

0

Bookmarked

2

Total users

1

Monthly active users

a month ago

Last modified

Security

Limited permissions

Share

Fetches and validates a public GitHub repository's .github/FUNDING.yml sponsorship configuration against GitHub's documented funding-platform syntax. Returns a readiness score, per-platform validation results, and specific fixes for malformed entries. Uses GitHub's public API and raw content delivery with no authentication required.

Use cases

  • Open source maintainers checking whether their Sponsor button configuration is correctly formatted before a release.
  • Developer relations and open source program office (OSPO) teams auditing sponsorship readiness across a portfolio of repositories.
  • Platforms and marketplaces (Tidelift, Open Collective, thanks.dev integrators) verifying that listed projects actually declare them in FUNDING.yml.
  • CI pipelines that lint .github/FUNDING.yml on pull requests before merge.
  • Grant and accelerator programs doing due diligence on a project's existing funding channel declarations.

Input

FieldTypeRequiredDefaultDescription
repoUrlsarray<string>yes-Public github.com/<owner>/<repo> URLs to audit (max 50 per run)
timeoutSecondsintegerno10Per-request timeout (3-30 seconds)

Example input

{
"repoUrls": [
"https://github.com/sveltejs/svelte",
"https://github.com/apify/crawlee"
],
"timeoutSeconds": 10
}

Output

Each repository produces one dataset item:

FieldTypeDescription
inputUrlstringThe GitHub URL provided
fullNamestringowner/repo identifier
okbooleanWhether the repository was reached
checkedAtstringISO timestamp
defaultBranchstringDefault branch used to locate FUNDING.yml
fundingFileFoundbooleanWhether .github/FUNDING.yml or .yaml exists on the default branch
fundingFilePathstringPath of the file found
fundingFileUrlstringRaw content URL of the fetched file
parseErrorstringYAML parse error, if any
platformsarrayPer-platform-key entries with key, value, valid
validbooleanTrue when the file has zero validation issues
issuesarraySpecific validation problems found
recommendationsarraySuggested fixes
scoreintegerReadiness score, 0-100
gradestringLetter grade, A-F
errorstringError message when ok is false

Validated platform syntax

The actor checks every key against GitHub's documented FUNDING.yml syntax:

KeyExpected syntax
githubUsername string or array of up to 4 usernames
patreon, open_collective, ko_fi, liberapay, issuehunt, polar, buy_me_a_coffeeSingle username string
community_bridgeProject name string
tideliftplatform-name/package-name
thanks_devu/gh/USERNAME
customURL string or array of up to 4 URLs

Any other key is flagged as unknown/unsupported. GitHub silently ignores malformed entries instead of raising an error, so the Sponsor button can be missing funding options without any visible warning on the repository page; this actor surfaces those silent failures.

Example output

{
"inputUrl": "https://github.com/sveltejs/svelte",
"fullName": "sveltejs/svelte",
"ok": true,
"checkedAt": "2026-10-05T12:00:00.000Z",
"defaultBranch": "main",
"fundingFileFound": true,
"fundingFilePath": ".github/FUNDING.yml",
"fundingFileUrl": "https://raw.githubusercontent.com/sveltejs/svelte/main/.github/FUNDING.yml",
"parseError": null,
"platforms": [
{ "key": "open_collective", "value": "svelte", "valid": true }
],
"valid": true,
"issues": [],
"recommendations": [],
"score": 70,
"grade": "C"
}

Security

  • Only github.com/<owner>/<repo> URLs are accepted as input.
  • URLs with embedded credentials are rejected.
  • Uses GitHub's unauthenticated public REST API (api.github.com) and public raw content delivery (raw.githubusercontent.com) only.
  • No tokens, no private repositories, no browser automation, no proxies.
  • Does not read local files or environment secrets.
  • Fetched file content is capped at 200 KB and parsed as YAML only; no code execution of file contents.

Pricing

Pay per event:

EventPrice
Actor start$0.005
Repository audited$0.01

A run auditing 10 repositories costs approximately $0.105.

FAQ

Do I need a GitHub token? No. The actor uses GitHub's unauthenticated public API and public raw content delivery. For high-volume use, run on Apify infrastructure where IP rotation is automatic.

What happens if a repository has no FUNDING.yml? The actor returns an item with ok: true, fundingFileFound: false, and a recommendation to add the file. It does not treat a missing file as a run failure.

What happens if a repository does not exist or is private? The actor returns an item with ok: false and the GitHub API error/status. It does not crash the run.

Does this actor render or verify the Sponsor button on the live repository page? No. It validates the FUNDING.yml syntax against GitHub's documented rules. Rendering the Sponsor button also depends on GitHub Sponsors account state, which is not publicly queryable per repository.

Can it check organization-wide default FUNDING.yml files? Not in this version. Point it at individual repository URLs; a future version may add org-level .github repository fallback lookup.