Skip to content

Joe-Huber/my-most-followed-followers

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Most Followed Followers GitHub Action

Update README Status GitHub release (latest by date) GitHub Marketplace Top Language Code Size Last Commit Issues Forks Stars License: MIT

This GitHub Action scrapes your most followed followers and displays them in a dynamic list on your profile's README.md.

Profile Name Followers
WildGenie 826
itszubariel 12
AwesomeCoder412412 9
macnmath 2
hiley-b 2

Last updated: 2026-06-10 02:15:03 UTC

Psst, if you follow me you can end up on here! ^-^

Usage

To use this action in your own repository, follow these steps:

  1. Update your README.md:

    Add the following placeholders to your README.md file. This is where the dynamic list of followers will be inserted.

    <!-- FOLLOWERS_LIST_START -->
    <!-- FOLLOWERS_LIST_END -->
  2. Create a GitHub Actions workflow:

    Create a new file in your repository at .github/workflows/update_readme.yml with the following content:

    name: Update README with Top Followers
    
    on:
      schedule:
        - cron: '0 0 * * *' # Runs daily at midnight
      workflow_dispatch:
    
    jobs:
      update-readme:
        runs-on: ubuntu-latest
        permissions:
          contents: write # Required to push changes back to the repository
        steps:
          - name: Check out repository
            uses: actions/checkout@v3
    
          - name: Update README with most followed followers
            uses: Joe-Huber/my-most-followed-followers@main
            with:
              GITHUB_USER_NAME: ${{ github.repository_owner }}
              MAX_FOLLOWER_COUNT: 10
          
          - name: Commit and push changes
            run: |
              git config --global user.name 'github-actions[bot]'
              git config --global user.email 'github-actions[bot]@users.noreply.github.com'
              git add README.md
              git commit -m "bot: automated follower list README update" || exit 0
              git push

    This workflow will run daily, but you can also trigger it manually from the "Actions" tab in your repository.

Inputs

The following inputs can be configured in your workflow file's with block:

Input Description Default Required
GITHUB_USER_NAME Your GitHub username. ${{ github.repository_owner }} true
MAX_FOLLOWER_COUNT The number of top followers to display in the table. 5 false

How It Works

This action uses a Docker container to run a Python script that:

  • Scrapes your followers using Selenium.
  • Finds your most followed followers.
  • Updates your README.md with a dynamically generated table.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Legal Note

Scraping is allowed under GitHub's Terms of Service for the purposes of this action. For more details, see the GitHub Acceptable Use Policies.