Profile Trophy Action

Languages / 语言 / Sprachen / Lingue / 언어 / 言語

• English
• 简体中文
• Deutsch
• Italiano
• 한국어
• 日本語

Generate GitHub Profile Trophy cards in your GitHub Actions workflow, commit them to your profile repository, and embed them directly from there.

This Action uses the Go implementation of github-profile-trophy service, downloading pre-built binaries from GitHub Releases and calling them via CLI to generate trophy cards.

Quick Start

name: Update README trophy

on:
  schedule:
    - cron: "0 0 * * *" # Runs once daily at midnight
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest

    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v4

      - name: Generate trophy card
        uses: soulteary/github-profile-trophy-action@v1.0.0
        with:
          options: 'username=${{ github.repository_owner }}&theme=gruvbox&column=7&margin-w=15&margin-h=15'
          path: profile/trophy.svg
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Commit trophy card
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add profile/trophy.svg
          git commit -m "Update README trophy" || exit 0
          git push

Then embed from your profile README:

![Trophy](./profile/trophy.svg)

Deployment Options

This action is a recommended deployment option. You can also deploy on Vercel or other platforms. See the GitHub Profile Trophy README.

Inputs

• options: Options for the trophy card as a query string (key=value&...) or JSON. If username is omitted, the action uses the repository owner.
• path: Output path for the SVG file. Defaults to profile/trophy.svg.
• token: GitHub token (PAT or GITHUB_TOKEN). For private repo stats, use a PAT with repo and read:user scopes.
• version: Version of github-profile-trophy binary to use (e.g., v1.0.0). Defaults to v1.0.0. Use latest to get the latest release.
• repo: GitHub repository in format owner/repo. Defaults to soulteary/github-profile-trophy.

Outputs

• path: Path where the SVG file was written.

Options Parameters

The options input accepts the following parameters:

• username (required) - GitHub username
• theme - Theme name (default: "default")
• column - Maximum number of columns (default: 8, use -1 for adaptive)
• row - Maximum number of rows (default: 3)
• margin-w - Horizontal margin between trophies (default: 0)
• margin-h - Vertical margin between trophies (default: 0)
• title - Filter by trophy titles (comma-separated, use - prefix to exclude)
• rank - Filter by ranks (comma-separated, use - prefix to exclude)
• no-bg - Transparent background (default: false)
• no-frame - Hide frames (default: false)

📖 Usage Examples

Basic Trophy Card

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

With Theme

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}&theme=onedark'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

Filter by Titles

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}&title=Stars,Followers'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

Filter by Ranks

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}&rank=S,AAA'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

Custom Layout

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}&column=3&row=2&margin-w=15&margin-h=15'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

Transparent Background

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}&theme=gruvbox&no-bg=true&no-frame=true'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

JSON Options

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: '{"username":"${{ github.repository_owner }}","theme":"gruvbox","column":7,"margin-w":15,"margin-h":15}'
    path: .github/assets/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

Specify Version

- name: Generate trophy card
  uses: soulteary/github-profile-trophy-action@v1.0.0
  with:
    options: 'username=${{ github.repository_owner }}&theme=gruvbox'
    path: profile/trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}
    version: v1.0.0  # Use specific version
    # version: latest  # Or use latest release

🎨 Available Themes

Choose from 20+ beautiful themes! All themes from the original project are supported.

Click to view all themes

default

flat

onedark

gruvbox

dracula

monokai

chalk

nord

alduin

darkhub

juicyfresh

oldie

buddhism

radical

onestar

discord

algolia

gitdimmed

tokyonight

matrix

apprentice

dark_dimmed

dark_lover

kimbie_dark

aura

Trophy Types

Base Trophies

• Stars, Commits, Followers, Issues, Pull Requests, Repositories, Reviews

Secret Trophies

• MultiLanguage (10+ languages)
• AllSuperRank (all base trophies are S rank or higher)
• LongTimeUser (10+ years)
• AncientUser (before 2010)
• OGUser (before 2008)
• Joined2020 (joined in 2020)
• Organizations (3+ organizations)
• Experience (account duration)

Rank System

Ranks are: SECRET, SSS, SS, S, AAA, AA, A, B, C, UNKNOWN

How It Works

This action works by:

1. Detecting Platform: Automatically detects the OS (Linux/macOS) and architecture (amd64/arm64)
2. Downloading Binary: Downloads the pre-built binary from GitHub Releases for the specified version
3. Calling CLI: Invokes the Go binary's CLI mode with the provided options
4. Saving File: Writes the generated SVG to the specified path

Differences from Original Version

Feature	Original Version	This Version
Implementation	Node.js	Bash
Service Call	Direct library function call	CLI call to Go binary
Dependencies	Node.js + npm package	curl (pre-installed)
Build	npm install	Download from Releases
Binary Source	npm package	GitHub Releases

Supported Platforms

• Linux (amd64, arm64)
• macOS (amd64, arm64)

The action automatically detects your runner's platform and downloads the appropriate binary.

Notes

• This action uses the same renderers and fetchers as soulteary/github-profile-trophy.
• No Go environment required - binaries are pre-built and downloaded from Releases.
• The service binary is temporarily downloaded and executed during the action run.
• For best performance, specify a version instead of using latest to avoid API calls.

License

MIT License