Retrieve GitHub repository commit history from Slack command

This template demonstrates how to fetch the GitHub repository commit history based on data triggered by Slack slash command, and then how to send the history back to the Slack channel where the message originated from. Get started to learn more.

What is ScriptRunner Connect?

ScriptRunner Connect is an AI assisted code-first (JavaScript/TypeScript) integration platform (iPaaS) for building complex integrations and automations.

Can I try it out for free?

Yes. ScriptRunner Connect comes with a forever free tier.

Can I customize the integration logic?

Absolutely. The main value proposition of ScriptRunner Connect is that you'll get full access to the code that is powering the integration, which means you can make any changes to the the integration logic yourself.

Can I change the integration to communicate with additional apps?

Yes. Since ScriptRunner Connect specializes in enabling complex integrations, you can easily change the integration logic to connect to as many additional apps as you need, no limitations.

What if I don't feel comfortable making changes to the code?

First you can try out our AI assistant which can help you understand what the code does, and also help you make changes to the code. Alternatively you can hire our professionals to make the changes you need or build new integrations from scratch.

Do I have to host it myself?

No. ScriptRunner Connect is a fully managed SaaS (Software-as-a-Service) product.

What about security?

ScriptRunner Connect is ISO 27001 and SOC 2 certified. Learn more about our security.

📋 Overview

This template demonstrates how to fetch the GitHub repository commit history based on data triggered by Slack slash command, and then how to send the history back to the Slack channel where the message originated from.

🖊️ Setup

• Configure the API Connection and Event Listener by creating connectors for GitHub and Slack, or use existing ones.
• (Optional) Go to Parameters and configure parameter to meet you needs.
• PS! Make sure the GitHub connector has an access to repositories that users may want to read from.

🚀 Usage

Trigger a Slack slash command (/command_name <REPOSITORY_OWNER> <REPOSITORY_NAME>), after successful event processing a message should be posted back to Slack with the commit history for the repository the user asked for.

import Slack from './api/slack';
import GitHub from './api/github';
import { SlashCommandEvent } from '@sr-connect/slack/events';
import { GetCommitsResponseOK } from '@managed-api/github-core/types/commit';

/**
 * This function fetches GitHub repository commit history based on data triggered by Slack's slash command, and then sends back history to Slack channel where the message originated from.
 * Command syntax: /command_name <REPOSITORY_OWNER> <REPOSITORY_NAME>
 *
 * @param event Object that holds Slash Command event data
 * @param context Object that holds function invocation context data
 */
export default async function (event: SlashCommandEvent, context: Context): Promise<void> {
    if (Object.keys(event).length === 0) {
        console.error('This script is designed to be triggered externally or manually from the Event Listener. Please consider using Event Listener Test Event Payload if you need to trigger this script manually.');
        return;
    }

    const envVars = context.environment.vars as EnvVars;

    try {
        // Split the command params
        const params = event.text.split(' ');

        // Check if correct number of params were passed along
        if (params.length !== 2) {
            // If not, then send appropriate message back to Slack
            await Slack.Chat.postMessage({
                body: {
                    channel: event.channel_id,
                    text: 'Invalid number of parameters, required parameters: <REPOSITORY_OWNER> <REPOSITORY_NAME>'
                }
            });

            // And halt the script execution
            return;
        }

        // Get the specified repository owner from the params array
        const repositoryOwner = params[0]

        // Get the specified repository name from the params array
        const repositoryName = params[1];

        // Find all the commits
        const commits = await GitHub.Commit.getCommits<null>({
            owner: repositoryOwner,
            repo: repositoryName,
            errorStrategy: builder => builder.http404Error(() => null) // In case the repository is not found, return null when 404 is returned
        });

        // If commits were found
        if (commits) {
            // Then take only the most recent number of MAX_COMMIST
            const filteredCommits = commits.slice(0, envVars.MAX_COMMITS);

            // Format commits into Slack's BlockKit message and send message back to Slack
            await Slack.Chat.postMessage({
                body: {
                    channel: event.channel_id,
                    blocks: [{
                        type: 'section',
                        text: {
                            type: 'mrkdwn',
                            text: `Commit history for ${repositoryOwner}/${repositoryName}${commits.length > envVars.MAX_COMMITS ? ` (${envVars.MAX_COMMITS} most recent)` : ''}:\n${filteredCommits.map(c => getCommitMessage(c)).join('\n')}`
                        }
                    }]
                }
            });
        } else {
            // If repository not found, send appropriate message
            await Slack.Chat.postMessage({
                body: {
                    channel: event.channel_id,
                    text: `Repository not found with repository owner ${repositoryOwner} and name ${repositoryName}`
                }
            });
        }
    } catch (e) {
        // If something went front, then log it out
        console.error('Error while processing slash command', event, e);

        // And send appropriate message back to Slack
        await Slack.Chat.postMessage({
            body: {
                channel: event.channel_id,
                text: 'Something went wrong while retrieving commit history'
            }
        });
    }
}

/**
 * Function that transforms a commit into Slack's compatible markdown format
 */
function getCommitMessage(commit: ArrayElement<GetCommitsResponseOK>) {
    return `• <${commit.html_url}|${commit.commit.message}> by ${commit.commit.author?.name ?? 'Unknown'} at ${new Date(commit.commit.author?.date ?? 0).toUTCString()}`;
}

// Helper type to help us pick out a single element type information from the array
type ArrayElement<A> = A extends readonly (infer T)[] ? T : never

interface EnvVars {
    MAX_COMMITS: number;
}