Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DenverCoderOne/readme-repos-list

🖇️ GitHub Action to list repositories in a README (fork of readme-repos-list by koj-co)
https://github.com/DenverCoderOne/readme-repos-list

automation github-actions readme readme-generator

Last synced: about 2 months ago
JSON representation

🖇️ GitHub Action to list repositories in a README (fork of readme-repos-list by koj-co)

Host: GitHub
URL: https://github.com/DenverCoderOne/readme-repos-list
Owner: DenverCoderOne
License: mit
Fork: true (AnandChowdhary/readme-repos-list)
Created: 2021-02-08T19:38:02.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2022-12-02T23:01:30.000Z (almost 2 years ago)
Last Synced: 2024-07-06T09:41:56.799Z (3 months ago)
Topics: automation, github-actions, readme, readme-generator
Language: TypeScript
Homepage:
Size: 765 KB
Stars: 6
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🖇️ README Repositories List

GitHub Action to list repositories in a README

[![Build CI](https://github.com/DenverCoderOne/readme-repos-list/workflows/Build%20CI/badge.svg)](https://github.com/DenverCoderOne/readme-repos-list/actions?query=workflow%3A%22Build+CI%22)

[![Node CI](https://github.com/DenverCoderOne/readme-repos-list/workflows/Node%20CI/badge.svg)](https://github.com/DenverCoderOne/readme-repos-list/actions?query=workflow%3A%22Node+CI%22)

## ⭐ Usage

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

```md

This is my fancy README

...the list will be added here...

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:

```yaml

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](https://github.com/alexpate/awesome-design-systems) - 💅🏻 ⚒ A collection of awesome design systems

* [awesome-kotlin](https://github.com/KotlinBy/awesome-kotlin) - A curated list of awesome Kotlin related stuff Inspired by awesome-java. 

* [Bombers](https://github.com/bhattsameer/Bombers) - SMS/Email/Whatsapp/Twitter/Instagram bombers Collection :bomb::bomb::bomb: :boom: 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](https://github.com/521xueweihan/HelloGitHub) - :octocat: 分享 GitHub 上有趣、入门级的开源项目。Share interesting, entry-level open source projects on GitHub.

* [patchwork](https://github.com/jlord/patchwork) - All the Git-it Workshop completers! 

### 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](https://docs.github.com/en/free-pro-team@latest/rest/reference/search#constructing-a-search-query) on GitHub Docs for more information. An example query can look like:

```

Octocat in:readme user:DenverCoder1

```

#### 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         |

| `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](./LICENSE) © 2020 [Koj](https://koj.co)

- 2020-2022 [Jonah Lawrence](https://github.com/DenverCoder1)

- "GitHub" is a trademark of GitHub, Inc.