Skip to main content
This feature requires manager (CTO/team lead) approval when applying migrations to the Production DB. It sends a Slack message and treats it as approved when a ✅ emoji is added.

​
Goals

Conscious Deployment

Recognize Production migrations as “non-routine separate tasks”

Force Option

Can force proceed without approval (with reason logged)

Duplicate Prevention

Skip re-request if same migration combination already approved

Failure Handling

Comment out config to restore original behavior during Slack outages

​
Configuration

​
sonamu.config.ts

export default defineConfig({
  // ... existing config

  slackConfirm: {
    targets: ["production"], // DB keys requiring approval
    botToken: process.env.SLACK_BOT_TOKEN ?? "",
    channelId: process.env.SLACK_CHANNEL_ID ?? "", // e.g., "C01234567"
  },
});

​
Environment Variables

SLACK_BOT_TOKEN=xoxb-...
SLACK_CHANNEL_ID=C01234567
Commenting out the slackConfirm block will restore the original behavior (immediate execution without approval).

​
Slack App Setup

​
1. Create App

  1. Slack API → Create New App
  2. Select “From scratch”
  3. App Name: “Sonamu Migration” (or your preferred name)
  4. Select Workspace

​
2. Add Bot Token Scopes

Go to OAuth & Permissions → Scopes → Bot Token Scopes and add:
ScopePurpose
chat:writeSend messages, post reasons in threads
reactions:readCheck emojis
reactions:writeAdd ✅ on force

​
3. Install and Configure

  1. Click Install to Workspace
  2. Copy Bot User OAuth Token (xoxb-...)
  3. In your channel, run /invite @botname
  4. Get Channel ID (right-click channel name → “Copy link” → C... part in URL)

​
Approval Flow

​
Approval Request Message

🗄️ *Production Migration Approval Request*

*Requestor:* user@example.com
*Target DB:* production
*Time:* 2025. 1. 15. 3:30:00 PM

*Pending Migrations:*
• 20251220143022_create__users.ts
• 20251220143100_create__posts.ts

✅ Approve  ❌ Reject

​
Usage

​
Normal Approval

  1. Click Apply for Production target migration in Sonamu UI
  2. Approval request message sent to Slack channel
  3. Manager clicks ✅ emoji
  4. Migration executes automatically

​
Force Proceed

When you need to proceed without waiting for approval:
  1. Click “Force Proceed” button while waiting
  2. Enter reason
  3. Migration executes (force reason logged to Slack)
Force proceeding logs the reason to the Slack thread. This can be tracked later for audit purposes.

​
Rejection Handling

When manager clicks ❌ emoji, the migration is rejected.

​
Local File Storage

Approval request information is stored locally to prevent re-requests for the same migration combination.

​
Storage Location

src/migrations/.slack-confirm-{hash}

​
Filename Convention

  • {hash} = MD5 hash of sorted migration names (12 characters)
  • Example: .slack-confirm-a1b2c3d4e5f6

​
File Contents

{channel_id}:{message_ts}
Example: C01234567:1705412345.000100

​
Slack API Reference

​
APIs Used

APIPurpose
chat.postMessageSend approval request message
reactions.getCheck emojis (Tier 3, 50+/min)
reactions.addAdd ✅ on force
chat.postMessage (thread_ts)Log to thread

​
Rate Limit

  • reactions.get is a Tier 3 API allowing 50+ calls per minute
  • When limit is exceeded, responses are delayed rather than blocked
  • Polling interval is set to 2 seconds, which is safe

​
Test Scenarios

ScenarioBehavior
Normal flowApply → Slack message → Wait → ✅ → Execute
Existing approvalApply → Check existing ts → ✅ exists → Execute immediately
RejectionApply → Wait → ❌ → Rejection message
ForceApply → Wait → Force → Enter reason → Execute
No configSame as original behavior (immediate execution)
Non-target DBDBs not in targets execute without approval

​
Next Steps

Running Migrations

Basic execution methods

Rolling Back

Undo with migrate rollback

Strategies

Safe migration strategies

How It Works

Understanding auto-generation