Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anandchowdhary/readme-repos-list
🖇️ GitHub Action to list repositories in a README
https://github.com/anandchowdhary/readme-repos-list
automation github-actions nodejs readme readme-md typescript
Last synced: 15 days ago
JSON representation
🖇️ GitHub Action to list repositories in a README
- Host: GitHub
- URL: https://github.com/anandchowdhary/readme-repos-list
- Owner: AnandChowdhary
- License: mit
- Created: 2020-11-05T07:54:10.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T15:05:39.000Z (22 days ago)
- Last Synced: 2024-10-30T05:36:20.819Z (17 days ago)
- Topics: automation, github-actions, nodejs, readme, readme-md, typescript
- Language: TypeScript
- Homepage:
- Size: 578 KB
- Stars: 17
- Watchers: 3
- Forks: 8
- Open Issues: 4
-
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
[](https://github.com/koj-co/readme-repos-list/actions?query=workflow%3A%22Build+CI%22)
[](https://github.com/koj-co/readme-repos-list/actions?query=workflow%3A%22Release+CI%22)
[](https://github.com/koj-co/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:
- 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:
[](https://hacktoberfest.digitalocean.com/)
[](https://nitskmos.github.io/Algorithms)
[](http://bit.ly/fnplusnow)
[](https://github.com/faroit/awesome-python-scientific-audio)
[](http://jlord.github.io/patchwork)
[](https://github.com/dzharii/awesome-typescript)
[](https://kotlin.link/)
[](https://git.io/design-systems)
[](https://drone.io)
[](https://hellogithub.com/)
### 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: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](./LICENSE) © [Koj](https://koj.co)
- "GitHub" is a trademark of GitHub, Inc.
An open source project by Koj.
Furnish your home in style, for as low as CHF175/month →