RedPlanetHQ/core

New Integration: Vercel

開放

#495 建立於 2026年2月24日

 (0 則留言) (0 個反應) (1 位負責人)TypeScript (184 個分叉)auto 404
enhancementgood first issueintegrationnew-featurenew-integration

倉庫指標

星標
 (1,930 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

Description

Add Vercel integration to sync deployment data, project configurations, domain management, and environment variables into CORE.

Reference Implementations

Existing Integrations (use as templates)

  • integrations/github/ - Similar developer platform system
  • integrations/linear/ - Project management integration
  • integrations/slack/ - For reference

Required Files Structure

integrations/vercel/
├── src/
│   ├── index.ts          # Main entry, OAuth spec
│   ├── schedule.ts       # Sync logic
│   ├── utils.ts          # Vercel API utilities
│   ├── account-create.ts # OAuth setup
│   └── create-activity.ts # Activity formatting
├── package.json
├── tsup.config.ts
└── README.md

Vercel API Integration

OAuth Setup

  • Use Vercel Access Tokens for authentication
  • Authorization header: Authorization: Bearer <TOKEN>
  • API supports HTTP/1 and HTTP/2 over SSL
  • Base URL: https://api.vercel.com
  • Developer docs: https://vercel.com/docs/rest-api

Key Endpoints

  • GET /v6/deployments - List deployments
  • POST /v13/deployments - Create a deployment
  • GET /v9/projects - List projects
  • GET /v6/domains - List domains
  • GET /v1/edge-config - Edge Config management
  • GET /v1/integrations - List integrations
  • GET /v9/projects/{id}/env - Environment variables
  • GET /v2/teams - List teams
  • GET /v1/security/checks - Security checks

Events to Track

  1. Deployments - Deployment created, deployment ready, deployment errored, deployment promoted
  2. Projects - Project created, project updated, project deleted
  3. Domains - Domain added, domain configured, domain verified, SSL issued
  4. Environment - Environment variable created, updated, deleted
  5. Team - Member invited, member removed, role changed

Implementation Tasks

  • Set up basic integration structure following integrations/github/src/index.ts pattern
  • Implement token-based authentication in account-create.ts
  • Create API utilities in utils.ts for Vercel API calls
  • Implement sync logic in schedule.ts for deployments, projects, and domains
  • Convert deployment events to CORE activity format
  • Add error handling and rate limiting
  • Create integration documentation
  • Add to integrations/README.md

Technical Notes

  • Rate limits communicated via response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
  • REST API documentation is automatically updated with API changes
  • Supports any programming language or framework that can send HTTP requests
  • Webhook integrations available for real-time deployment notifications
  • API versioning via URL path (e.g., /v6/, /v13/)

Resources

Labels

enhancement, integration, new-feature

貢獻者指南