This GitHub Action queries the GitHub API to retrieve your starred repositories and generates a README sorted by your stargazed list.
You can reference my repository Frestein/awesome-stars. You can use it as template.
| Variable | Description | Default |
|---|---|---|
github-username |
GitHub username for generating starred list | / |
git-message |
Commit message for Git commits | chore(updates): updated entries in files |
sort-by |
Sort by stars or updated |
stars |
style |
Style of README generation (table or list) |
table |
template-path |
Custom README.md template path Learn more |
template/template.md |
output-path |
Output filename | README.md |
The default template path is template/template.md. You can customize the template path (relative to repository root).
The generated content will replace the [[GENERATE HERE]] placeholder in the template while preserving other content.
Default output file name is README.md. You can customize the output path (relative to repository root).
name: Update by list
on:
workflow_dispatch:
schedule:
- cron: 0 0 * * *
jobs:
update-by-list:
runs-on: ubuntu-latest
steps:
- name: Update category by list
uses: Frestein/[email protected]
with:
github-username: ${{ github.repository_owner }}
git-message: "docs(list): bump data"
sort-by: stars
style: list
template-path: .github/templates/template.md
output-path: README.md
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}