GitHub Action to list repositories in a README

You can create your README.md file with some comments, where this action will add a list of repositories:

This is my fancy README

<!-- start: YOUR_STARTER -->...the list will be added here...<!-- end: YOUR_STARTER -->

Your README continues after the list

By default, "readme-repos-list" is the value for YOUR_STARTER. Then, add the workflow which runs, for example, every day:

name: README Repos List
on:
  schedule:
    # run every day at midnight
    - cron: "0 0 * * *"
jobs:
  list:
    runs-on: ubuntu-latest
    steps:
      - name: Run readme-repos-list
        uses: DenverCoderOne/[email protected]
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          query: "Octocat in:readme"
          max: 5

This will create a README like so:

• awesome-design-systems - 💅🏻 ⚒ A collection of awesome design systems

• awesome-kotlin - A curated list of awesome Kotlin related stuff Inspired by awesome-java.

• Bombers - SMS/Email/Whatsapp/Twitter/Instagram bombers Collection 💣💣💣 💥 Also added collection of some Fake SMS utilities which helps in skip phone number based SMS verification by using a temporary phone number that acts like a proxy.

• HelloGitHub - 分享 GitHub 上有趣、入门级的开源项目。Share interesting, entry-level open source projects on GitHub.

• patchwork - All the Git-it Workshop completers!

Your GitHub token or personal access token. If you don't have a bot account, you should use the default ${{ secrets.GITHUB_TOKEN }}.

Search query used to find repositories. See Constructing a search query on GitHub Docs for more information. An example query can look like:

Octocat in:readme user:DenverCoder1

• Code: MIT © 2020 Koj
• 2020-2022 Jonah Lawrence
• "GitHub" is a trademark of GitHub, Inc.