DEV Community

Cover image for Github Action - Repository Roster | Shout-out Supporters In Your README.md
Varun Sridharan
Varun Sridharan

Posted on

Github Action - Repository Roster | Shout-out Supporters In Your README.md

As developers, we put a lot of work into our GitHub repos to make them as useful as possible for others, but great projects sometimes go under-appreciated, and under-starred. Asking for stars is tacky, but publicly thanking your supporters by name in your README file is a sign of appreciation that happens to incentivize more users to join the crowd.

💡 Inspiration

One fine day i got an email DEV Digest in which i got attracted by the title 1 Step to Incentivize Stars and Forks on GitHub and decided to read the full article. it was new & interesting to me.Thanks to @ nastyox1 creating such awesome tool. so i wanted to use it but i wanted it to be a markdown-table output which was not an option with that cloud hosted service. so i decided to create this as an action which can provide various outputs.

check out the examples output


🚀 Usage

  1. Update Your README.md with below code
  2. Setup Action Workflow File

Repository Stargazers

    ## ↳ Stargazers
    <!-- REPOSITORY_STARS:START --> <!-- REPOSITORY_STARS:END -->
Enter fullscreen mode Exit fullscreen mode

Repository Forks

    ## ↳ Forkers
    <!-- REPOSITORY_FORKS:START --><!-- REPOSITORY_FORKS:END -->
Enter fullscreen mode Exit fullscreen mode

ℹ️ Currently there are ways to auto trigger the workflow when a users stars / forks the repository.

ℹ️ Using this action with the workflow trigger fork & watch is the best optmized way.

if you want to remove users that have un-stared / deleted the fork then you might have to use cron to handle it

Example Workflowfile

name: "🙏 Repository Roster"

on:
  workflow_dispatch:
  watch:
    types:
      - started
  fork:

jobs:
  update_latest_roster:
    name: "🐔  Update Latest Roster"
    runs-on: ubuntu-latest
    steps:
      - name: "📥  Fetching Repository Contents"
        uses: actions/checkout@main

      - name: "🐔  Markdown - Repository Roster"
        uses: "varunsridharan/action-repository-roster@main"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Enter fullscreen mode Exit fullscreen mode

For Details information about the available config options. please check our github repository

GitHub logo varunsridharan / action-repository-roster

Shout-out supporters in your GitHub README file.

~ Shout-out supporters in your GitHub README file. ~

🚀 Usage

  1. Setup Action Workflow File
  2. Update Your README.md with below code

Repository Stargazers

    ## ↳ Stargazers
    <!-- REPOSITORY_STARS:START --> <!-- REPOSITORY_STARS:END -->
Enter fullscreen mode Exit fullscreen mode

Repository Forks

    ## ↳ Forkers
    <!-- REPOSITORY_FORKS:START --><!-- REPOSITORY_FORKS:END -->
Enter fullscreen mode Exit fullscreen mode

ℹ️ Currently there are ways to auto trigger the workflow when a users stars / forks the repository.

ℹ️ Using this action with the workflow trigger fork & watch is the best optmized way.

if you want to remove users that have un-stared / deleted the fork then you might have to use cron to handle it


⚙️ Configuration

Option Description Default
General Config
IMAGE_SAVE_PATH Custom location on where to save generated SVG image file.
Image Files Are Generated When Output Type Set To image
.github/roster/
Forks Config
FORK Set to true to generate latest forked users information. or provide a file location to update the information
If
…

Top comments (0)