profiles.dev

Your self-managed developer profile, powered by GitHub. Create and maintain your own profile on profiles.dev!

Existing users: See the Migration Guide for updating to v2.

🚀 Quick Start (30 seconds)

⚠️ Important: Repository Naming Requirement

Your repository MUST be named profiles.dev to work with the profiles.dev service. This is a security requirement to ensure you control your own profile.

Option 1: Use This Template (Recommended)

1. Click the "Use this template" button above
2. Name your repo exactly profiles.dev (required!)
3. Edit profile.yaml with your information
4. Commit and push - your profile auto-updates!

Option 2: Manual Setup

1. Create a new repository named profiles.dev in your GitHub account
2. Add this workflow to .github/workflows/update-profile.yml:

name: Update profiles.dev

on:
  push:
    branches: [ main ]  # or 'master' if that's your default
    paths:
      - 'profile.yaml'
  # NOTE: workflow_dispatch is NOT supported

permissions:
  id-token: write
  contents: read

jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: nomadops/profiles.dev@v2

3. Create your profile.yaml and push!

📝 Profile Configuration

Edit profile.yaml to customize your profile. All fields are optional:

name: Jane Developer
bio: Full-stack developer passionate about open source
location: San Francisco, CA
email: jane@example.com
website: https://jane.dev

# Social links
twitter: "@janedev"
github: janedev
linkedin: https://linkedin.com/in/janedev

# Professional info
skills:
  - TypeScript
  - React
  - Node.js

projects:
  - name: Cool Project
    description: An amazing project
    url: https://github.com/janedev/cool-project

See the full profile schema below for all available fields.

🎨 Your Profile URL

Once set up, your profile will be available at:

https://profiles.dev/YOUR_GITHUB_USERNAME

🔒 Security & Requirements

profiles.dev uses a self-service model where you control your own profile:

• Repository Name: Must be exactly profiles.dev
• Updates: Only via push to your default branch (no manual triggers)
• Authentication: Uses GitHub OIDC tokens for secure updates
• Rate Limiting: Maximum 1 update per minute

These requirements ensure that only you can update your profile.

📋 Profile Schema

Click to see all available fields

Basic Information

• name - Your display name
• bio - Brief description about yourself
• company - Current company/organization
• location - Your location
• email - Contact email
• website - Personal website

Social Links

• twitter - Twitter/X handle or URL
• github - GitHub username
• linkedin - LinkedIn profile URL

Professional

• skills - Array of skills
• languages - Array of languages

Projects

Array of projects with:

• name (required)
• description
• url
• role

Experience

Array of work experiences with:

• company (required)
• position (required)
• duration
• description

Education

Array of education with:

• institution (required)
• degree
• field
• year

Certifications

Array of certifications with:

• name (required)
• issuer
• year
• url

🛠️ Advanced Usage

Manual Updates

Trigger a manual update anytime:

1. Go to Actions tab
2. Select "Update profiles.dev"
3. Click "Run workflow"

Custom Configuration

- uses: nomadops/profiles.dev@v1
  with:
    profile-path: 'custom/path/to/profile.yaml'
    debug: true

Multiple Profiles

strategy:
  matrix:
    profile: [personal.yaml, professional.yaml]
steps:
  - uses: actions/checkout@v4
  - uses: nomadops/profiles.dev@v1
    with:
      profile-path: ${{ matrix.profile }}

🔧 For Action Developers

This repository also contains the GitHub Action source code. See ACTION_README.md for development details.

🤝 Contributing

We welcome contributions! Whether it's:

• 🐛 Bug fixes
• ✨ New features
• 📚 Documentation improvements
• 💡 Ideas and suggestions

Please open an issue or submit a PR.

📜 License

MIT © NomadOps

---

Made with ❤️ by the NomadOps team

profiles.dev • Issues • Marketplace