A GitHub Action that automatically updates your README with a list of repositories you've starred on GitHub, categorized by programming language.

Usage

Basic Setup

Add this to your workflow file (e.g., .github/workflows/update-stars.yml):

name: Update Starred Repositories

permissions: write-all

on:
  schedule:
    - cron: '5 4 * * *'   # Run daily at 4:05 AM
  workflow_dispatch:      # Allow manual trigger

jobs:
  update-stars:
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3
      - name: Update README with Starred Repositories
        uses: mxvsh/starkit@v2.4.2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          github-username: ${{ github.actor }}

Configurations

You can use markers to identify the section of your README that you want to update.

# My Starred Repositories

<!-- STARRED_REPOS_START -->

<!-- STARRED_REPOS_END -->

You can customize the action by passing additional parameters:

• readme-path: Path to your README file (default: README.md)
• start-marker: Marker to identify section start (default: <!-- STARRED_REPOS_START -->)
• end-marker: Marker to identify section end (default: <!-- STARRED_REPOS_END -->)
• include-languages: Comma-separated list of languages to include (optional)
• exclude-languages: Comma-separated list of languages to exclude (optional)
• sort-by: Sort order (name or count, default: name)
• max-repos: Maximum number of repositories per language (optional)
• build-web: Set to true to build a web version for GitHub Pages (default: false)

GitHub Pages Integration

Starkit can build a beautifully formatted web version of your starred repositories using GitHub Pages. This creates an interactive web app where you can filter and search through your repositories.

Setting up GitHub Pages

Simply add build-web: true to your workflow configuration. Starkit will automatically:

1. Build the web application
2. Create or update the gh-pages branch
3. Deploy the built files directly to GitHub Pages

No additional actions or configuration needed!

Example workflow with GitHub Pages integration:

name: Update Starred Repositories with GitHub Pages

permissions:
  contents: write # Needed for updating README and gh-pages branch

on:
  schedule:
    - cron: '5 4 * * *'   # Run daily at 4:05 AM
  workflow_dispatch:      # Allow manual trigger

jobs:
  update-stars:
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3
      - name: Update README and Build Web
        uses: mxvsh/starkit@v2.4.2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          github-username: ${{ github.actor }}
          build-web: true

After successful deployment, your website will be available at https://{username}.github.io/{repository-name}/. Make sure to enable GitHub Pages in your repository settings to serve from the gh-pages branch.

Feature Roadmap

• Web version with GitHub Pages integration
• Custom badges for each language
• Categorize by repository topics
• Group by organization/owner
• Filter by creation/update date
• Collapsible sections by language

License

This project is licensed under the MIT License. See the LICENSE file for details.

Credits

This project is inspired by stargazer.