Repository files navigation

ThisGitHub Action will automatically add yourGitHub Sponsors to your README. It can be configured in multiple ways allowing you to display and breakdown your sponsors by price tier with fallbacks. It also includes templating support so you can display your sponsors how you'd like.

Maintenance of this project is made possible by all thecontributors andsponsors. If you'd like to sponsor this project and have your avatar or company logo appear belowclick here. 💖

You can include the action in your workflow to trigger on any event thatGitHub Actions supports.

name:Generate Sponsors READMEon:workflow_dispatch:schedule:    -cron:30 15 * * 0-6permissions:contents:writejobs:deploy:runs-on:ubuntu-lateststeps:      -name:Checkout 🛎️uses:actions/checkout@v2      -name:Generate Sponsors 💖uses:JamesIves/github-sponsors-readme-action@v1with:token:${{ secrets.PAT }}file:'README.md'# ⚠️ Note: You can use any deployment step here to automatically push the README# changes back to your branch.      -name:Deploy to GitHub Pages 🚀uses:JamesIves/github-pages-deploy-action@v4with:branch:mainfolder:'.'

You'll also need to add the following<!-- sponsors --><!-- sponsors --> in your.md file so the action knows where to place the data.

#Awesome ProjectGo you!##SponsorsThese are our really cool sponsors!<!-- sponsors--><!-- sponsors-->

If you'd like to use the functionality provided by this action in your own action you can eithercreate a composite action, or you can install it usingyarn ornpm by running the following commands. It's available on both thenpm andGitHub registry.

yarn add @jamesives/github-sponsors-readme-action

npm install @jamesives/github-sponsors-readme-action

It can then be imported into your project like so.

importrunfrom'@jamesives/github-sponsors-readme-action'run({token:process.env.GITHUB_TOKEN})

Calling the functions directly will require you to pass in an object containing the variables found in theconfiguration section.

Thewith portion of the workflowmust be configured before the action will work. You can add these in thewith section found in the examples above. Anysecrets must be referenced using the bracket syntax and stored in the GitHub repository'sSettings/Secrets menu. You can learn more about setting environment variables with GitHub actionshere.

The following options must be configured.

The action will export a step output assponsorship-status that you can use in your workflow to determine if the task was successful or not. You can find an explanation of each status type below.

You can modify the template that gets generated in your file by using thetemplate input. This input allows you to leverage mustache templating to modify what is displayed. The following values are available.

You're able to use markdown or GitHub approved basic HTML. The default template can be foundhere.

name:Generate Sponsors READMEon:push:branches:      -mainpermissions:contents:writejobs:deploy:runs-on:ubuntu-lateststeps:      -name:Checkout 🛎️uses:actions/checkout@v2      -name:Generate Sponsors 💖uses:JamesIves/github-sponsors-readme-action@v1with:token:${{ secrets.PAT }}file:'README.md'template:'* [{{ name }}]({{ url }}) - {{ login }}'      -name:Deploy to GitHub Pages 🚀uses:JamesIves/github-pages-deploy-action@v4with:branch:mainfolder:'.'

#Awesome ProjectGo you!##SponsorsThese are our really cool sponsors!<!-- sponsors--><!-- sponsors-->

If you'd like to highlight certain users who contribute to a specific sponsorship tier you can do so using a combination of theminimum,maximum andmarker inputs. Theminimum / maximum inputs equal their dollar contribution in cents.

name:Generate Sponsors READMEon:push:branches:      -mainpermissions:contents:writejobs:deploy:runs-on:ubuntu-lateststeps:      -name:Checkout 🛎️uses:actions/checkout@v2      -name:Generate Sponsors 💖uses:JamesIves/github-sponsors-readme-action@v1with:token:${{ secrets.PAT }}file:'README.md'minimum:500maximum:999marker:'silver'      -name:Generate Sponsors 💖uses:JamesIves/github-sponsors-readme-action@v1with:token:${{ secrets.PAT }}file:'README.md'minimum:1000marker:'gold'      -name:Deploy to GitHub Pages 🚀uses:JamesIves/github-pages-deploy-action@v4with:branch:mainfolder:'.'

#Awesome ProjectGo you!##Gold Sponsors<!-- gold--><!-- gold-->##Silver Sponsors<!-- silver--><!-- silver-->