readme-repos-list
TypeScript icon, indicating that this package has built-in type declarations

1.3.2 • Public • Published

🖇️ README Repositories List

GitHub Action to list repositories in a README

Build CI Release CI Node CI

Usage

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:
    - cron: "0 0 * * 1"
jobs:
  list:
    runs-on: ubuntu-latest
    steps:
      - name: Run readme-repos-list
        uses: koj-co/readme-repos-list@master
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          query: "Octocat in:readme"
          max: 10

This will create a README like so:

fnplus/Algorithms-Hacktoberfest NITSkmOS/Algorithms fnplus/interview-techdev-guide faroit/awesome-python-scientific-audio jlord/patchwork dzharii/awesome-typescript KotlinBy/awesome-kotlin alexpate/awesome-design-systems drone/drone 521xueweihan/HelloGitHub

Inputs

token (required)

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

query (required)

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:koj-co

Optional inputs

Input Description
owner Owner of repository to commit to
repo Name of repository to commit to
max Maximum number of repositories to list
prefix Content to add before the list
weserv-query Image manipulation query parameters
no-homepage Link to repository, not homepage
suffix Content to add at the end of the list
path Path to file to update with content
start Starting comment to look for
end Ending comment
commit-message Updating file commit message
one-per-owner Show only one repo per owner
sort Sort repositories by this parameter
order Order by "asc" or "desc"

📄 License

  • Code: MIT © Koj
  • "GitHub" is a trademark of GitHub, Inc.

Koj

An open source project by Koj.
Furnish your home in style, for as low as CHF175/month →

Package Sidebar

Install

npm i readme-repos-list

Weekly Downloads

17

Version

1.3.2

License

MIT

Unpacked Size

594 kB

Total Files

22

Last publish

Collaborators

  • kojbot