A GitHub Action that fetches your research publications from ORCID and generates a formatted card for your GitHub README.
- 🔍 Fetches publications directly from ORCID public API
- 📝 Generates beautiful Markdown cards
- ⚡ Fast and lightweight
- 🔗 Includes DOI links to papers
The action generates beautiful SVG cards in a table layout:
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 -->
- Go to orcid.org
- Sign in or create an account
- Your ORCID ID is in the format:
0009-0002-7320-1041 - Copy it from your profile URL
# 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
MIT
Contributions welcome! Please open an issue or PR.