Skip to content

About

Display your latest research releases in your README

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Latest commit

 

History

10 Commits

Folders and files

Repository files navigation

📚 GitHub README ORCID Cards

A GitHub Action that fetches your research publications from ORCID and generates a formatted card for your GitHub README.

Features

  • 🔍 Fetches publications directly from ORCID public API
  • 📝 Generates beautiful Markdown cards
  • ⚡ Fast and lightweight
  • 🔗 Includes DOI links to papers

Usage

Example Output

The action generates beautiful SVG cards in a table layout:

Gaussian Splatting vs. Classic VR Planica: Gaussian Splatting

Basic Example

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

name: Update ORCID Publications

on:
  schedule:
    - cron: '0 0 * * 0'  # Weekly on Sunday
  workflow_dispatch:  # Manual trigger

jobs:
  update-publications:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      
      - name: Fetch ORCID Publications
        uses: fierc3/github-readme-orcid-cards@main
        with:
          orcid_id: '0009-0002-7320-1041'  # Replace with your ORCID
          max_papers: 10
      
      - name: Commit and push if changed
        run: |
          git config --global user.name 'github-actions[bot]'
          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
          git add README.md cards/
          git diff --quiet && git diff --staged --quiet || (git commit -m "Update ORCID publications" && git push)

Important: Add these comment markers to your README where you want the cards to appear:

<!-- BEGIN ORCID-CARDS -->
<!-- END ORCID-CARDS -->

Finding Your ORCID ID

  1. Go to orcid.org
  2. Sign in or create an account
  3. Your ORCID ID is in the format: 0009-0002-7320-1041
  4. Copy it from your profile URL

Development

Local Testing

# Install dependencies
pip install -r requirements.txt

# Run
source venv/bin/activate.fish && set -x INPUT_ORCID_ID "0009-0002-7320-1041" && set -x INPUT_MAX_PAPERS "4" && python src/main.py

License

MIT

Contributing

Contributions welcome! Please open an issue or PR.

Support

About

Display your latest research releases in your README

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages