How to Link GitHub Commits to Jira Tickets with Pipedream

Workflows > New > Start from scratch

Create New Workflow in Pipedream

Navigate to pipedream.com and click Workflows in the sidebar. Click the blue New button in the top right. Select 'Start from scratch' when the template picker appears. Name your workflow 'GitHub Commit to Jira Comments' in the workflow title field.

1. 1Click Workflows in the left sidebar
2. 2Click the blue New button in top right corner
3. 3Select 'Start from scratch' from template options
4. 4Type 'GitHub Commit to Jira Comments' in the title field

Trigger Step > Choose app > GitHub > New Push

Add GitHub Push Event Trigger

Click the 'Choose app or service' button in the trigger step. Search for 'GitHub' and select it from the results. Choose 'New Push' from the available GitHub events. This trigger fires every time someone pushes commits to your repository.

1. 1Click 'Choose app or service' in the trigger box
2. 2Type 'GitHub' in the search field
3. 3Select 'GitHub' from the dropdown results
4. 4Click 'New Push' from the event list

GitHub Trigger > Connect Account

Connect Your GitHub Account

In the GitHub trigger configuration, click 'Connect Account' next to the Account field. A popup will open asking for GitHub authorization. Click 'Authorize Pipedream' to grant access to your repositories. After authorization completes, select your target repository from the Repository dropdown.

1. 1Click 'Connect Account' button in the trigger config
2. 2Click 'Authorize Pipedream' in the GitHub popup window
3. 3Return to Pipedream and refresh if needed
4. 4Select your repository from the Repository dropdown

GitHub Trigger > Generate Test Event

Test GitHub Trigger Setup

Click the 'Generate Test Event' button at the bottom of the GitHub trigger step. Pipedream will create a sample push event with realistic commit data. This test data helps you build the rest of the workflow without making actual commits.

1. 1Scroll to bottom of GitHub trigger configuration
2. 2Click the blue 'Generate Test Event' button
3. 3Wait for the test event to populate (takes 3-5 seconds)
4. 4Expand the event data to see commit details

Workflow > + > Custom Code > Node.js

Add Code Step to Parse Commit Messages

Click the + button below the GitHub trigger to add a new step. Select 'Custom Code' from the step types. Choose 'Run Node.js Code' as your runtime. This step will extract Jira ticket keys from commit messages using regex pattern matching.

1. 1Click the + icon below the GitHub trigger step
2. 2Select 'Custom Code' from the step type menu
3. 3Choose 'Run Node.js Code' from runtime options
4. 4Name the step 'Parse Commit Messages'

This Node.js code goes in the 'Parse Commit Messages' step to extract Jira tickets and format commit data. Paste it in the code editor after clearing the default template.

export default defineComponent({
  async run({ steps, $ }) {
    const commits = steps.trigger.event.commits || [];

export default defineComponent({
  async run({ steps, $ }) {
    const commits = steps.trigger.event.commits || [];
    const repository = steps.trigger.event.repository.full_name;
    const ticketPattern = /\b[A-Z]{2,10}-\d{1,6}\b/g;
    
    const processedCommits = [];
    
    for (const commit of commits) {
      const ticketMatches = commit.message.match(ticketPattern);
      
      if (ticketMatches && ticketMatches.length > 0) {
        // Remove duplicates and process each unique ticket
        const uniqueTickets = [...new Set(ticketMatches)];
        
        for (const ticketKey of uniqueTickets) {
          const commentBody = `**Commit by ${commit.author.name}**: ${commit.message}\n\n` +
                            `**SHA**: \`${commit.id.substring(0, 8)}\`\n\n` +
                            `**View Changes**: https://github.com/${repository}/commit/${commit.id}`;
          
          processedCommits.push({
            ticketKey: ticketKey,
            commentBody: commentBody,
            commitSha: commit.id,
            authorName: commit.author.name,
            commitMessage: commit.message,
            timestamp: commit.timestamp
          });
        }
      }
    }
    
    if (processedCommits.length === 0) {
      $.flow.exit('No Jira ticket keys found in commit messages');
    }
    
    return processedCommits;
  }
});

Code Step > Editor

Add Commit Parsing Logic

Replace the default code with logic to find Jira ticket keys in commit messages. The code loops through all commits in the push and extracts ticket keys using a regex pattern. Each matching commit gets prepared for sending to Jira with the commit details.

1. 1Clear the existing code in the editor
2. 2Paste the commit parsing code (see Pro Tip section)
3. 3Click 'Test' button to run the code with test data
4. 4Verify the parsed output shows ticket keys and commit data

Workflow > + > Jira > Add Comment to Issue

Add Jira Comment Action

Click the + button below the code step to add another step. Search for 'Jira' and select it from the apps list. Choose 'Add Comment to Issue' from the available Jira actions. This action will post the commit details as comments on the matching tickets.

1. 1Click + below the code step
2. 2Type 'Jira' in the app search field
3. 3Select 'Jira Software Cloud' from results
4. 4Choose 'Add Comment to Issue' from action list

Jira Step > Connect Account

Connect Your Jira Account

In the Jira step configuration, click 'Connect Account' to authorize Pipedream access to your Jira instance. Enter your Jira site URL when prompted (like yourcompany.atlassian.net). Generate an API token from your Jira account settings and paste it in the authentication form.

1. 1Click 'Connect Account' in the Jira step
2. 2Enter your Jira site URL (yourcompany.atlassian.net)
3. 3Go to Jira > Account Settings > Security > API tokens
4. 4Create new token and paste it in Pipedream auth form

Jira Step > Issue Key & Comment Body

Configure Issue Key and Comment Body

Map the Issue Key field to the ticket key extracted from the code step. In the Comment Body field, format the commit information including commit message, author, SHA, and GitHub link. Use the data from previous steps to build a readable comment format.

1. 1Click in Issue Key field and select ticket key from code step data
2. 2Click in Comment Body field to open the text editor
3. 3Format comment with commit message, author, and SHA
4. 4Add GitHub commit URL using repository and commit SHA

Workflow > Test Button

Test Complete Workflow

Click the 'Test' button at the top of the workflow to run all steps with the test data. Check that the code step successfully parses commit messages and the Jira step posts comments without errors. Verify the actual Jira ticket received the commit comment.

1. 1Click the green 'Test' button in workflow header
2. 2Watch each step execute in sequence
3. 3Check for green checkmarks on all completed steps
4. 4Open the Jira ticket to verify comment was added

Workflow > Deploy

Deploy Workflow

Click the 'Deploy' button to activate the workflow for live events. Once deployed, the workflow will automatically process new GitHub pushes and add comments to matching Jira tickets. The workflow URL appears in the deployment confirmation for webhook setup if needed.

1. 1Click the blue 'Deploy' button in workflow header
2. 2Confirm deployment in the popup dialog
3. 3Wait for 'Deployed' status to appear
4. 4Note the webhook URL for GitHub repository settings