🎬 A powerful GitHub Action that automatically showcases your featured repositories in your profile README with customizable display formats and flexible configuration options.

This GitHub Action fetches repositories filtered by topics and automatically updates your profile README with beautiful, customizable displays. Perfect for showcasing your best work, featured projects, or portfolio pieces directly on your GitHub profile.

• 🎨 Multiple display formats: Choose from cards, lists, or tables to match your style
• 🏷️ Topic-Based Filtering: Filter repositories by any topic (defaults to "showcase")
• 👑 Scalable Display: Show up to 100 repositories with customizable limits
• 🎛️ Flexible Configuration: Control visibility of descriptions, languages, stars, forks, and topics
• 🚀 Automated Updates: Schedule automatic updates or trigger manually
• 🔒 Safe Integration: Uses HTML markers for targeted updates without affecting existing content
• 🐳 Docker Compatible: Runs seamlessly in containerized environments
• ✅ Comprehensive Testing: Full test coverage ensures reliability

Add HTML comment markers to your README.md where you want repositories to appear:

# Your GitHub Profile

Welcome to my profile! Here are some of my featured projects:

<!-- SHOWCASE-START -->
<!-- SHOWCASE-END -->

Feel free to explore and contribute!

Create .github/workflows/update-readme.yml in your profile repository:

name: Update README with Featured Repositories

on:
  schedule:
    - cron: '0 6 * * *' # Daily at 6 AM UTC
  workflow_dispatch: # Manual trigger

permissions:
  contents: write

jobs:
  update-readme:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Update README with Repository Display
        uses: sansk/github-repo-display@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          username: ${{ github.repository_owner }}
          topic: 'showcase'
          format: 'card'

Add the "showcase" topic to repositories you want to feature:

1. Navigate to your repository on GitHub
2. Click the gear icon (⚙️) next to "About" in the sidebar
3. Add "showcase" to the topics field
4. Click "Save changes"

The action will automatically detect and display these repositories on the next run.

- name: Update README with Repository Display
  uses: sansk/github-repo-display@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    username: ${{ github.repository_owner }}

- name: Update README with Repository Display
  uses: sansk/github-repo-display@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    username: ${{ github.repository_owner }}
    topic: 'featured'
    format: 'table'
    title: '🌟 Featured Projects'
    max_repos: 12
    show_description: true
    show_language: true
    show_stars: true
    show_forks: true
    show_topics: true
    commit_message: 'docs: update featured projects showcase'

• All boolean parameters accept true or false values
• String parameters should be provided with quotes
• The action only fetches public repositories with the specified topic
• Maximum repository limit is enforced at 100 to maintain performance

Displays repositories as GitHub-style cards using the github-readme-stats service:

Creates a clean bulleted list with optional badges and metadata:

• 🧑‍💻 awesome-project

  

  An awesome project

• cool-app

  

  A very cool application Visit Website

Organizes repository information in a structured table format:

Repository	Description	Language	Stars	Forks
Spoon-Knife	This repo is for demonstration purposes only.		⭐ 13.2k	🔀 153k
git-consortium	This repo is for demonstration purposes only. Live Website		⭐ 455	🔀 129
octocat.github.io			⭐ 892	🔀 433

• Node.js 18 or higher
• npm package manager
• GitHub Personal Access Token

# Clone the repository
git clone https://github.com/sansk/github-repo-display.git
cd github-repo-display

# Install dependencies
npm install

# Run tests
npm test

# Build the action
npm run build

Comprehensive testing instructions are available in our Development Testing Guide.

We're continuously working to improve the GitHub Repository Display Action.

[ ] Bug Fixes

We welcome contributions! Please see our Contributing Guidelines for details on:

• Code of conduct
• Development workflow
• Submitting pull requests
• Reporting issues

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

If you're using this project and find it helpful, or would like to encourage continued development, here are some ways you can contribute:

• 🐛 Report & Request: Help improve the project by reporting bugs or requesting features via GitHub Issues
• 🔗 Give Credit: When using this action in your README, consider linking back to this repository to help others discover it
• ⭐ Star & Share: Give the project a star on GitHub and share it with your developer community 🚀
• ☕ Buy Me a Coffee: Support ongoing development with a small contribution 🍵

Your support helps keep open source project like this alive and thriving. Thanks! ❤️

• github-readme-stats for powering the card display format
• GitHub Actions team for the excellent platform