feat(SA-675): add Slack notifications for membership changes

- Add slack.ts module with notification functionality
- Add config options: SLACK_WEBHOOK_URL, SLACK_NOTIFY_ON_ERROR,
  SLACK_NOTIFY_ON_CHANGE, SLACK_NOTIFY_ALWAYS
- Update action.yml with new Slack inputs
- Send notifications on errors (default), changes (opt-in), or always
- Format messages with users added, removed, and any errors

Author: gjarzebak95

action.yml

@@ -41,6 +41,21 @@ inputs:
   github-actor:
     description: github actor to use to pull the docker image github.actor is probably fine
     required: true
+  slack-webhook-url:
+    description: 'Slack webhook URL for notifications'
+    required: false
+  slack-notify-on-error:
+    description: 'Send Slack notification when errors occur (default: true)'
+    required: false
+    default: 'true'
+  slack-notify-on-change:
+    description: 'Send Slack notification when membership changes are made'
+    required: false
+    default: 'false'
+  slack-notify-always:
+    description: 'Always send Slack notification regardless of changes'
+    required: false
+    default: 'false'
 runs:
   using: "composite"
   steps:
@@ -63,6 +78,10 @@ runs:
         -e GITHUB_INSTALLATION_ID="$GITHUB_INSTALLATION_ID" \
         -e GITHUB_PRIVATE_KEY="$GITHUB_PRIVATE_KEY" \
         -e IGNORED_USERS="$IGNORED_USERS" \
+        -e SLACK_WEBHOOK_URL="$SLACK_WEBHOOK_URL" \
+        -e SLACK_NOTIFY_ON_ERROR="$SLACK_NOTIFY_ON_ERROR" \
+        -e SLACK_NOTIFY_ON_CHANGE="$SLACK_NOTIFY_ON_CHANGE" \
+        -e SLACK_NOTIFY_ALWAYS="$SLACK_NOTIFY_ALWAYS" \
         docker.pkg.github.com/appvia/githubusermanager/githubusermanager:v1.0.5
       shell: bash
       env:
@@ -76,4 +95,8 @@ runs:
         GITHUB_INSTALLATION_ID: ${{ inputs.github-installation-id }}
         GITHUB_PRIVATE_KEY: ${{ inputs.github-private-key }}
         IGNORED_USERS: ${{ inputs.ignored-users }}
+        SLACK_WEBHOOK_URL: ${{ inputs.slack-webhook-url }}
+        SLACK_NOTIFY_ON_ERROR: ${{ inputs.slack-notify-on-error }}
+        SLACK_NOTIFY_ON_CHANGE: ${{ inputs.slack-notify-on-change }}
+        SLACK_NOTIFY_ALWAYS: ${{ inputs.slack-notify-always }}
 

index.ts

@@ -1,6 +1,7 @@
 import { getGithubUsersFromGoogle } from './src/google'
 import { getGithubUsersFromGithub, addUsersToGitHubOrg, removeUsersFromGitHubOrg, OperationError } from './src/github'
 import { config } from './src/config'
+import { notifySlack } from './src/slack'
 
 export async function run(): Promise<void> {
   const googleUsers = await getGithubUsersFromGoogle()
@@ -14,11 +15,14 @@ export async function run(): Promise<void> {
   const usersNotInGoogle = new Set(Array.from(gitHubUsers).filter((x) => !googleUsers.has(x)))
   let unfixedMismatch = false
   const allErrors: OperationError[] = []
+  const addedUsers: string[] = []
+  const removedUsers: string[] = []
 
   if (usersNotInGithub.size > 0) {
     console.log(`Users not in github: ${Array.from(usersNotInGithub).join(', ')}`)
     if (config.addUsers) {
       const result = await addUsersToGitHubOrg(usersNotInGithub)
+      addedUsers.push(...result.success)
       if (result.errors.length > 0) {
         allErrors.push(...result.errors)
       }
@@ -31,6 +35,7 @@ export async function run(): Promise<void> {
     console.log(`Users not in google: ${Array.from(usersNotInGoogle).join(', ')}`)
     if (config.removeUsers) {
       const result = await removeUsersFromGitHubOrg(usersNotInGoogle)
+      removedUsers.push(...result.success)
       if (result.errors.length > 0) {
         allErrors.push(...result.errors)
       }
@@ -47,6 +52,8 @@ export async function run(): Promise<void> {
     console.error(`Total errors: ${allErrors.length}`)
   }
 
+  await notifySlack(addedUsers, removedUsers, allErrors, config.githubOrg)
+
   const hasErrors = allErrors.length > 0
   const exitCode = unfixedMismatch || hasErrors ? config.exitCodeOnMissmatch : 0
 

src/config.ts

@@ -29,6 +29,18 @@ export const config = {
   get googleEmailAddress(): string {
     return process.env.GOOGLE_EMAIL_ADDRESS ?? ''
   },
+  get slackWebhookUrl(): string | undefined {
+    return process.env.SLACK_WEBHOOK_URL
+  },
+  get slackNotifyOnError(): boolean {
+    return process.env.SLACK_NOTIFY_ON_ERROR?.toLowerCase() !== 'false'
+  },
+  get slackNotifyOnChange(): boolean {
+    return process.env.SLACK_NOTIFY_ON_CHANGE?.toLowerCase() === 'true'
+  },
+  get slackNotifyAlways(): boolean {
+    return process.env.SLACK_NOTIFY_ALWAYS?.toLowerCase() === 'true'
+  },
 }
 
 export interface googleCredentials {

src/slack.ts

@@ -0,0 +1,141 @@
+import * as https from 'https'
+import { URL } from 'url'
+import { config } from './config'
+import { OperationError } from './github'
+
+export interface SlackMessage {
+  text: string
+  blocks?: SlackBlock[]
+}
+
+export interface SlackBlock {
+  type: string
+  text?: { type: string; text: string }
+  elements?: { type: string; text: string }[]
+}
+
+export async function sendSlackNotification(message: SlackMessage): Promise<boolean> {
+  const webhookUrl = config.slackWebhookUrl
+  if (!webhookUrl) {
+    return false
+  }
+
+  return new Promise((resolve) => {
+    try {
+      const url = new URL(webhookUrl)
+      const postData = JSON.stringify(message)
+
+      const options = {
+        hostname: url.hostname,
+        port: 443,
+        path: url.pathname,
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          'Content-Length': Buffer.byteLength(postData),
+        },
+      }
+
+      const req = https.request(options, (res) => {
+        if (res.statusCode === 200) {
+          resolve(true)
+        } else {
+          console.error(`Slack notification failed: ${res.statusCode}`)
+          resolve(false)
+        }
+      })
+
+      req.on('error', (error) => {
+        console.error(`Slack notification error: ${error}`)
+        resolve(false)
+      })
+
+      req.write(postData)
+      req.end()
+    } catch (error) {
+      console.error(`Slack notification error: ${error}`)
+      resolve(false)
+    }
+  })
+}
+
+export function formatMembershipUpdate(
+  added: string[],
+  removed: string[],
+  errors: OperationError[],
+  org: string,
+): SlackMessage {
+  const hasChanges = added.length > 0 || removed.length > 0
+  const hasErrors = errors.length > 0
+
+  let emoji = ':white_check_mark:'
+  if (hasErrors && !hasChanges) {
+    emoji = ':x:'
+  } else if (hasErrors) {
+    emoji = ':warning:'
+  }
+
+  const blocks: SlackBlock[] = [
+    {
+      type: 'header',
+      text: { type: 'plain_text', text: `${emoji} GitHub Org Sync: ${org}` },
+    },
+  ]
+
+  if (added.length > 0) {
+    blocks.push({
+      type: 'section',
+      text: { type: 'mrkdwn', text: `*Users Added:* ${added.join(', ')}` },
+    })
+  }
+
+  if (removed.length > 0) {
+    blocks.push({
+      type: 'section',
+      text: { type: 'mrkdwn', text: `*Users Removed:* ${removed.join(', ')}` },
+    })
+  }
+
+  if (errors.length > 0) {
+    const errorText = errors.map((e) => `• [${e.operation}] ${e.user}: ${e.message}`).join('\n')
+    blocks.push({
+      type: 'section',
+      text: { type: 'mrkdwn', text: `*Errors:*\n${errorText}` },
+    })
+  }
+
+  if (!hasChanges && !hasErrors) {
+    blocks.push({
+      type: 'section',
+      text: { type: 'mrkdwn', text: 'No changes required - all users in sync.' },
+    })
+  }
+
+  return {
+    text: `GitHub Org Sync: ${added.length} added, ${removed.length} removed, ${errors.length} errors`,
+    blocks,
+  }
+}
+
+export async function notifySlack(
+  added: string[],
+  removed: string[],
+  errors: OperationError[],
+  org: string,
+): Promise<void> {
+  const hasChanges = added.length > 0 || removed.length > 0
+  const hasErrors = errors.length > 0
+
+  const shouldNotify =
+    (hasErrors && config.slackNotifyOnError) || (hasChanges && config.slackNotifyOnChange) || config.slackNotifyAlways
+
+  if (!shouldNotify) {
+    return
+  }
+
+  const message = formatMembershipUpdate(added, removed, errors, org)
+  const sent = await sendSlackNotification(message)
+  if (sent) {
+    console.log('Slack notification sent')
+  }
+}

tests/index.spec.ts

@@ -1,7 +1,9 @@
 jest.mock('../src/google')
 jest.mock('../src/github')
+jest.mock('../src/slack')
 import * as google from '../src/google'
 import * as github from '../src/github'
+import * as slack from '../src/slack'
 import * as mod from '../index'
 
 let processExitSpy