Skip to main content Production deployment checklist for MaintainX integrations.
Use when preparing to deploy a MaintainX integration to production,
verifying production readiness, or auditing existing deployments.
Trigger with phrases like "maintainx production", "deploy maintainx",
"maintainx go-live", "maintainx production checklist", "maintainx launch".
npx skills add jeremylongshore/claude-code-plugins-plus-skills --skill maintainx-prod-checklist ai automation claude-code devops mcp ai-agents
MaintainX Production Checklist
Overview
Comprehensive pre-deployment and post-deployment checklist for MaintainX integrations covering security, reliability, observability, and data integrity.
Prerequisites
MaintainX integration developed and tested
Production MaintainX account with API access
Deployment infrastructure ready (Cloud Run, K8s, or similar)
Instructions
Step 1: Authentication & Security
# Verify production API key works
curl -s -o /dev/null -w "HTTP %{http_code}" \
https://api.getmaintainx.com/v1/users?limit=1 \
-H "Authorization: Bearer $MAINTAINX_API_KEY_PROD"
# Verify no secrets in codebase
npx gitleaks detect --source . --no-git
Step 2: Error Handling & Resilience // Verify retry logic is configured
const client = axios.create({
baseURL: 'https://api.getmaintainx.com/v1',
timeout: 30_000, // 30 second timeout
headers: { Authorization: `Bearer ${apiKey}` },
});
Step 3: Data Integrity
Step 4: Observability
Step 5: Performance
Step 6: Deployment
Post-Deployment Verification #!/bin/bash
echo "=== Post-Deployment Verification ==="
# 1. Health check
echo -n "Health check: "
curl -s http://YOUR_SERVICE_URL/health | jq -r '.status'
# 2. API connectivity
echo -n "MaintainX API: "
curl -s -o /dev/null -w "%{http_code}" \
https://api.getmaintainx.com/v1/users?limit=1 \
-H "Authorization: Bearer $MAINTAINX_API_KEY_PROD"
echo ""
# 3. Create test work order
echo "Creating test work order..."
WO=$(curl -s -X POST https://api.getmaintainx.com/v1/workorders \
-H "Authorization: Bearer $MAINTAINX_API_KEY_PROD" \
-H "Content-Type: application/json" \
-d '{"title":"Post-deploy verification test","priority":"LOW"}')
WO_ID=$(echo $WO | jq -r '.id')
echo " Created: #$WO_ID"
# 4. Verify retrieval
echo -n "Retrieve test: "
curl -s "https://api.getmaintainx.com/v1/workorders/$WO_ID" \
-H "Authorization: Bearer $MAINTAINX_API_KEY_PROD" | jq -r '.status'
# 5. Clean up
curl -s -X PATCH "https://api.getmaintainx.com/v1/workorders/$WO_ID" \
-H "Authorization: Bearer $MAINTAINX_API_KEY_PROD" \
-H "Content-Type: application/json" \
-d '{"status":"CLOSED"}' > /dev/null
echo " Cleaned up test work order #$WO_ID"
# 6. Check metrics endpoint
echo -n "Metrics endpoint: "
curl -s -o /dev/null -w "%{http_code}" http://YOUR_SERVICE_URL/metrics
echo ""
echo "=== Verification complete ==="
Go-Live Readiness Summary Category Requirement Priority Auth Secret manager, no hardcoded keys P0 Errors Retry + backoff for 429/5xx P0 Data Pagination, idempotency, sync state P0 Observability Logging, metrics, health check P0 Performance Connection pooling, caching P1 Security Input validation, audit logging P1 Deployment Docker, non-root, resource limits P1 Recovery Rollback procedure, reconciliation P2
Output
All P0 checklist items verified before go-live
Post-deployment verification script run successfully
Test work order created and cleaned up in production
Health check and metrics endpoints responding
Go-live readiness documented
Error Handling Issue Check Solution Health check fails post-deploy curl /healthCheck API key is mounted, restart pod Test work order creation fails Check HTTP status Verify API key permissions and plan tier Metrics endpoint 404 Check route config Ensure metrics server started on correct port High error rate after deploy Check logs Roll back, investigate, fix, redeploy
Resources
Next Steps For API version migrations, see maintainx-upgrade-migration.
Examples Automated pre-deploy gate in CI :
# .github/workflows/deploy.yml
jobs:
pre-deploy-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: npx gitleaks detect --source . --no-git
- run: npm run test -- --coverage --coverageThreshold='{"global":{"branches":80}}'
- run: npm run lint
- run: npm run typecheck
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
