documenso-prod-checklist
Execute Documenso production deployment checklist and rollback procedures. Use when deploying Documenso integrations to production, preparing for launch, or implementing go-live procedures. Trigger with phrases like "documenso production", "deploy documenso", "documenso go-live", "documenso launch checklist".
- License 许可
- MIT
- 最近更新
- 2026-11-15
- Stars
- ★ 2.0k
- Forks
- 233
01 前言 Front Matter
- name
- documenso-prod-checklist
- author
- Jeremy Longshore <jeremy@intentsolutions.io>
- license
- MIT
- version
- 1.0.0
- description
- Execute Documenso production deployment checklist and rollback procedures. Use when deploying Documenso integrations to production, preparing for launch, or implementing go-live procedures. Trigger with phrases like "documenso production", "deploy documenso", "documenso go-live", "documenso launch checklist".
- allowed-tools
- Read, Bash(kubectl:*), Bash(curl:*), Grep
03 SKILL.md 正文
Documenso Production Checklist
Overview
Complete checklist for deploying Documenso document signing integrations to production.
Prerequisites
- Staging environment tested and verified
- Production API keys available
- Deployment pipeline configured
- Monitoring and alerting ready
Pre-Deployment Checklist
Configuration
- [ ] Production API key generated (separate from staging)
- [ ] API key stored in secure vault (not in code)
- [ ] Environment variables configured in deployment platform
- [ ] Webhook endpoint URL uses HTTPS
- [ ] Webhook secret configured
- [ ] Base URL correct for environment
Code Quality
- [ ] All tests passing (
npm test) - [ ] No hardcoded credentials or API keys
- [ ] Error handling covers all Documenso error types
- [ ] Rate limiting/backoff implemented
- [ ] Logging is production-appropriate (no sensitive data)
- [ ] TypeScript strict mode enabled
Security
- [ ] API keys have minimal required permissions
- [ ] Webhook signature verification implemented
- [ ] Input validation on all user inputs
- [ ] File upload validation (type, size)
- [ ] Signing URLs not exposed in logs
- [ ] Audit logging enabled
Infrastructure
- [ ] Health check endpoint includes Documenso connectivity
- [ ] Monitoring/alerting configured for errors
- [ ] Circuit breaker pattern implemented
- [ ] Graceful degradation for Documenso outages
Documentation
- [ ] Incident runbook created
- [ ] API key rotation procedure documented
- [ ] Rollback procedure documented
- [ ] On-call escalation path defined
Deployment Procedure
Step 1: Pre-flight Checks
# Verify staging health
curl -f https://staging.yourapp.com/health
# Verify Documenso API status
curl -s https://status.documenso.com/api/v2/status.json | jq '.status'
# Run final test suite
npm run test:integration
Step 2: Deploy with Gradual Rollout
# Deploy to production (canary - 10%)
kubectl apply -f k8s/production.yaml
kubectl set image deployment/signing-service app=image:new --record
kubectl rollout pause deployment/signing-service
# Monitor canary for 10 minutes
echo "Monitoring canary deployment..."
sleep 600
# Check error rates
kubectl logs -l app=signing-service --since=10m | grep -c "ERROR"
# If healthy, continue to 50%
kubectl rollout resume deployment/signing-service
kubectl rollout pause deployment/signing-service
sleep 300
# Complete rollout to 100%
kubectl rollout resume deployment/signing-service
kubectl rollout status deployment/signing-service
Step 3: Health Check Implementation
// src/health.ts
import { getDocumensoClient } from "./documenso/client";
interface HealthStatus {
status: "healthy" | "degraded" | "unhealthy";
checks: {
documenso: {
connected: boolean;
latencyMs: number;
error?: string;
};
database?: {
connected: boolean;
latencyMs: number;
};
};
version: string;
}
export async function healthCheck(): Promise<HealthStatus> {
const checks: HealthStatus["checks"] = {
documenso: { connected: false, latencyMs: 0 },
};
// Test Documenso connectivity
const docStart = Date.now();
try {
const client = getDocumensoClient();
await client.documents.findV0({ perPage: 1 });
checks.documenso = {
connected: true,
latencyMs: Date.now() - docStart,
};
} catch (error: any) {
checks.documenso = {
connected: false,
latencyMs: Date.now() - docStart,
error: error.message,
};
}
// Determine overall status
const allHealthy = checks.documenso.connected;
const anyFailed = !checks.documenso.connected;
return {
status: allHealthy ? "healthy" : anyFailed ? "unhealthy" : "degraded",
checks,
version: process.env.APP_VERSION ?? "unknown",
};
}
// Express endpoint
app.get("/health", async (req, res) => {
const health = await healthCheck();
const statusCode = health.status === "unhealthy" ? 503 : 200;
res.status(statusCode).json(health);
});
Step 4: Monitoring Setup
// Monitor key metrics
interface DocumensoMetrics {
requestsTotal: number;
errorsTotal: number;
latencyP50Ms: number;
latencyP99Ms: number;
rateLimitHits: number;
}
class MetricsCollector {
private latencies: number[] = [];
private errors = 0;
private requests = 0;
private rateLimits = 0;
recordRequest(latencyMs: number, success: boolean): void {
this.requests++;
this.latencies.push(latencyMs);
if (!success) this.errors++;
// Keep last 1000 latencies
if (this.latencies.length > 1000) {
this.latencies = this.latencies.slice(-1000);
}
}
recordRateLimit(): void {
this.rateLimits++;
}
getMetrics(): DocumensoMetrics {
const sorted = [...this.latencies].sort((a, b) => a - b);
return {
requestsTotal: this.requests,
errorsTotal: this.errors,
latencyP50Ms: sorted[Math.floor(sorted.length * 0.5)] ?? 0,
latencyP99Ms: sorted[Math.floor(sorted.length * 0.99)] ?? 0,
rateLimitHits: this.rateLimits,
};
}
}
// Export to Prometheus/Datadog/etc
app.get("/metrics", (req, res) => {
const metrics = metricsCollector.getMetrics();
res.json(metrics);
});
Step 5: Alert Configuration
| Alert | Condition | Severity | Action |
|---|---|---|---|
| API Down | 5xx errors > 10/min | P1 | Page on-call |
| High Latency | p99 > 5000ms | P2 | Investigate |
| Rate Limited | 429 errors > 5/min | P2 | Reduce throughput |
| Auth Failures | 401/403 errors > 0 | P1 | Check API key |
| Webhook Failures | 4xx/5xx on webhook | P2 | Check endpoint |
# Example Datadog alert config
alerts:
- name: documenso_api_errors
query: sum(last_5m):sum:documenso.errors{env:production} > 10
message: "High Documenso API error rate"
priority: P1
- name: documenso_high_latency
query: avg(last_5m):avg:documenso.latency.p99{env:production} > 5000
message: "Documenso API latency elevated"
priority: P2
- name: documenso_rate_limits
query: sum(last_5m):sum:documenso.rate_limits{env:production} > 5
message: "Hitting Documenso rate limits"
priority: P2
Rollback Procedure
Immediate Rollback
# Kubernetes rollback
kubectl rollout undo deployment/signing-service
kubectl rollout status deployment/signing-service
# Verify rollback
kubectl get pods -l app=signing-service
curl -f https://yourapp.com/health
Feature Flag Rollback
// Use feature flags to disable Documenso features
const documensoEnabled = await featureFlags.isEnabled("documenso_signing");
if (!documensoEnabled) {
throw new Error("Document signing temporarily unavailable");
}
Post-Deployment Verification
# Run smoke tests
npm run test:smoke
# Verify document creation
curl -X POST https://yourapp.com/api/documents \
-H "Authorization: Bearer $USER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Test Document"}'
# Verify webhook delivery
# Check webhook logs in Documenso dashboard
# Monitor for 30 minutes
watch -n 30 'curl -s https://yourapp.com/health | jq'
Output
- Deployed Documenso integration
- Health checks passing
- Monitoring active
- Rollback procedure tested
Error Handling
| Alert | Condition | Response |
|---|---|---|
| Deploy failed | CI/CD error | Check logs, retry |
| Health check failed | Documenso down | Implement degraded mode |
| Rollback needed | Error spike | Execute rollback |
| Rate limits hit | Too many requests | Reduce throughput |
Resources
Next Steps
For version upgrades, see documenso-upgrade-migration.
04 同仓库更多 Skills
theme-factory
Toolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact that has been creating, or can generate a new theme on-the-fly.
web-artifacts-builder
Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
webapp-testing
Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.
neuropixels-analysis
Neuropixels neural recording analysis. Load SpikeGLX/OpenEphys data, preprocess, motion correction, Kilosort4 spike sorting, quality metrics, Allen/IBL curation, AI-assisted visual analysis, for Neuropixels 1.0/2.0 extracellular electrophysiology. Use when working with neural recordings, spike sorting, extracellular electrophysiology, or when the user mentions Neuropixels, SpikeGLX, Open Ephys, Kilosort, quality metrics, or unit curation.
skill-creator
Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
notebooklm
Use this skill to query your Google NotebookLM notebooks directly from Claude Code for source-grounded, citation-backed answers from Gemini. Browser automation, library management, persistent auth. Drastically reduced hallucinations through document-only responses.