How to generate release notes from GitHub to Jira with Pipedream

Pipedream > New Workflow > Sources > GitHub

Create GitHub webhook source

Navigate to pipedream.com and click New Workflow. Select GitHub as your source app from the triggers list. Choose the 'New Release Published' event type. Pipedream generates a unique webhook URL instantly.

1. 1Click 'New Workflow' from your dashboard
2. 2Select 'GitHub' from the source apps
3. 3Choose 'New Release Published' event
4. 4Copy the generated webhook URL

GitHub Repo > Settings > Webhooks > Add webhook

Configure GitHub repository webhook

In your GitHub repo, go to Settings > Webhooks > Add webhook. Paste the Pipedream URL in the payload URL field. Set content type to application/json and select 'Releases' in the event selection.

1. 1Navigate to your repository settings
2. 2Click 'Webhooks' in the left sidebar
3. 3Click 'Add webhook' button
4. 4Paste the Pipedream URL in Payload URL
5. 5Select 'application/json' for Content type
6. 6Choose 'Let me select individual events'
7. 7Check only 'Releases' checkbox

Pipedream Workflow > + Add Step > Jira

Add Jira connection step

Back in Pipedream, click '+' to add a new step. Search for Jira and select 'Jira' from the apps list. Choose any Jira action for now - we'll customize with code. Connect your Jira account using your domain, email, and API token.

1. 1Click the '+' button below your GitHub source
2. 2Type 'Jira' in the app search box
3. 3Select 'Jira' from results
4. 4Click 'Connect your account'
5. 5Enter your Jira domain (yourcompany.atlassian.net)
6. 6Enter your Jira email and API token

Pipedream Workflow > + Add Step > Code

Add code step for ticket extraction

Add a Node.js code step to parse the release body for Jira ticket references. This step will scan the release description and commit messages for ticket patterns like 'PROJ-123' or 'fixes #123'.

1. 1Click '+' to add another step
2. 2Select 'Code' from the step types
3. 3Choose 'Run Node.js code'
4. 4Replace the default code with ticket extraction logic

This code handles the core logic for extracting Jira tickets from GitHub release data and updating their status. Paste it into your ticket extraction code step.

export default defineComponent({
  async run({ steps, $ }) {
    const releaseBody = steps.trigger.event.body;

export default defineComponent({
  async run({ steps, $ }) {
    const releaseBody = steps.trigger.event.body;
    const releaseCommits = steps.trigger.event.commits || [];
    
    // Extract ticket patterns like PROJ-123, ABC-456
    const ticketRegex = /([A-Z]{2,}-\d+)/g;
    const tickets = new Set();
    
    // Check release description
    if (releaseBody) {
      const bodyTickets = releaseBody.match(ticketRegex) || [];
      bodyTickets.forEach(ticket => tickets.add(ticket));
    }
    
    // Check commit messages in release
    releaseCommits.forEach(commit => {
      const commitTickets = commit.message.match(ticketRegex) || [];
      commitTickets.forEach(ticket => tickets.add(ticket));
    });
    
    const ticketList = Array.from(tickets);
    
    if (ticketList.length === 0) {
      $.respond({ message: 'No Jira tickets found in release', tickets: [] });
      return { tickets: [] };
    }
    
    // Update tickets to Done status
    const jiraResults = [];
    for (const ticketKey of ticketList) {
      try {
        const response = await $.send.http({
          method: 'PUT',
          url: `https://yourcompany.atlassian.net/rest/api/2/issue/${ticketKey}/transitions`,
          headers: {
            'Authorization': `Basic ${Buffer.from('your-email:your-api-token').toString('base64')}`,
            'Content-Type': 'application/json'
          },
          data: {
            transition: { id: '31' } // 31 is typically 'Done' - check your workflow
          }
        });
        jiraResults.push({ ticket: ticketKey, status: 'updated' });
      } catch (error) {
        jiraResults.push({ ticket: ticketKey, status: 'failed', error: error.message });
      }
    }
    
    return { tickets: ticketList, results: jiraResults };
  }
});

Pipedream Workflow > + Add Step > Code

Configure ticket status updates

Add another code step to update each found Jira ticket to 'Done' status. This step loops through the extracted ticket IDs and makes PUT requests to update their workflow status.

1. 1Add another Node.js code step
2. 2Import the ticket IDs from the previous step
3. 3Loop through each ticket ID
4. 4Make API calls to transition tickets to Done

Pipedream Workflow > + Add Step > Code

Fetch ticket summaries

Create a code step to retrieve the summary and description fields from each Jira ticket. This data becomes the content for your release notes. Use Jira's REST API to get issue details in a single batch request.

1. 1Add a new Node.js code step
2. 2Use the Jira REST API to fetch issue details
3. 3Request summary, description, and issue type fields
4. 4Store the results for release notes compilation

Pipedream Workflow > + Add Step > Code

Generate formatted release notes

Add a final code step to compile ticket summaries into formatted release notes. Group tickets by type (bug, feature, task) and create markdown or HTML output suitable for your documentation.

1. 1Create another Node.js code step
2. 2Group tickets by issue type or label
3. 3Format as markdown or HTML
4. 4Include ticket links and release metadata

Pipedream Workflow > + Add Step > Slack/Email

Add notification step

Connect Slack or email to send the generated release notes to your team. Choose Slack if you want channel notifications, or email for stakeholder updates. The message includes the formatted notes and release link.

1. 1Click '+' to add a final step
2. 2Choose 'Slack' or 'Send Email' from apps
3. 3Connect your Slack workspace or email service
4. 4Select target channel or recipient
5. 5Reference the formatted release notes from previous step

Pipedream Workflow > Deploy

Test the complete workflow

Deploy your workflow and create a test GitHub release to verify all steps execute correctly. Check that Jira tickets update to Done status and release notes generate with the expected format.

1. 1Click 'Deploy' in the top right
2. 2Go to your GitHub repo and create a test release
3. 3Include some Jira ticket references in the description
4. 4Watch the workflow execution in Pipedream's logs
5. 5Verify tickets updated in Jira and notes were sent