Skip to content

PRE_DEPLOYMENT_CHECKLIST.md

Latest commit

 

History

History
111 lines (79 loc) · 2.32 KB

PRE_DEPLOYMENT_CHECKLIST.md

File metadata and controls

111 lines (79 loc) · 2.32 KB

Pre-Deployment Checklist

✅ Code Changes Complete

  • Removed custom admin endpoint from src/server/index.ts
  • Updated src/server/ai/gemini.ts to use Devvit settings
  • Added settings configuration to devvit.json
  • Updated all documentation
  • Build successful with no errors
  • No TypeScript diagnostics

📋 Before Deploying

1. Set the Gemini API Key

npx devvit settings set apiKey "YOUR_GEMINI_API_KEY"

Get your API key from: https://aistudio.google.com/app/apikey

2. Verify Settings

npx devvit settings list

You should see:

apiKey: ********** (set)

3. Build and Upload

# Build and upload
npm run deploy

# Or do it manually:
npm run build
npx devvit upload

🧪 After Deployment - Testing

Test the Analysis Endpoint

  1. Upload a document through the UI
  2. Check if AI analysis runs automatically
  3. Verify description and summary are generated

Check Logs

# View logs for your app
npx devvit logs YOUR_SUBREDDIT --since 5m

Look for:

  • [Gemini] Client initialized successfully
  • [Analysis] Starting document analysis
  • No "API key not configured" errors

🔍 Troubleshooting

If analysis fails with "API key not configured"

  1. Verify the setting is set:

    npx devvit settings list

  2. If not set, run:

    npx devvit settings set apiKey "YOUR_KEY"

  3. Re-upload if needed:

    npx devvit upload

If you see "settings is not defined" error

This means the Devvit SDK version might not support settings. Check:

npm list @devvit/web

Should be a recent version that supports settings.

📝 What Changed

This deployment migrates from Redis-based API key storage to Devvit's built-in settings system:

  • Before: Custom admin endpoint + Redis storage
  • After: CLI-based settings management

See GEMINI_SETTINGS_MIGRATION.md for full details.

✅ Ready to Deploy

All checks passed! You can now:

  1. Set the API key: npx devvit settings set apiKey
  2. Upload: npx devvit upload
  3. Test the analysis feature

📚 Documentation Updated

  • ✅ GEMINI_API_KEY_SETUP.md - Setup instructions
  • ✅ GEMINI_SETTINGS_MIGRATION.md - Migration details
  • ✅ .kiro/specs/gemini-analysis/ - Spec documents
  • ✅ PRE_DEPLOYMENT_CHECKLIST.md - This file