GitHub

Middleware's GitHub integration enables you to track and monitor key events from your repositories, such as code pushes, commits, pull requests, dependabot alert, and build failures. It ensures seamless collaboration by linking code events to incidents, providing real-time insights, and enhancing project security. With Middleware, your team can monitor repository health, detect build failures, and stay updated on code changes effortlessly.

Prerequisites

Setup

Follow these steps to set up GitHub integration with Middleware account.

1. Log in to your GitHub account and navigate to the Settings > Code and Automation > Webhooks.
2. Click on Add webhook.
3. In the Payload URL field, paste the Middleware's Intake Webhook URL, appears as:

https://<MW_UID>.middleware.io:443/v1/integration/github?mw_api_key=<MW_API_KEY>

4. Set the Content type to application/json.
5. Choose the events you want to track from the following list:
   • Branch or Tag Creation
   • Branch or Tag Deletion
   • Commit Comments
   • Dependabot Alert
   • Discussion
   • Discussion Comment
   • Issue Comments
   • Issues
   • Public - Visibility Changes
   • Pull Request Review Comments
   • Pull Request Reviews
   • Pull Requests
   • Pushes & Commits
   • Releases
   • Repositories
   • Security and Analyses
   • Team Adds
6. After saving the changes on the GitHub side, specify your desired repositories and branches on the Middleware side to filter the events you want to track.

Features

1. Real-Time Monitoring:

• Tracks pushes, commits, and pull requests instantly.

2. Build Failure Detection:

• Detects and alerts on build failures or system issues caused by code changes.

3. Enhanced Collaboration:

• Facilitates discussions and reviews directly within your workflow.

4. Incident Management:

• Links code events to new or existing incidents.

5. Security Monitoring:

• Monitors repository vulnerability alerts and collaborator changes.

GitHub Event Mappings

Middleware maps all supported GitHub events to corresponding log types on Middleware's logs screen. Each event is categorized by its action type and assigned a log level, such as info, warning, error, or debug. This ensures that events are appropriately flagged and prioritized for review. Below is an example of how some events are mapped:

• Create Branch/Tag Event: Marked as Info log.
• Delete Branch/Tag Event: Marked as Error log.
• Pull Request Event:
  • opened : Marked as Info log.
  • closed : Marked as Error log.
  • locked, unlocked, unassigned, unlabeled : Marked as Warning log.
  • ready_for_review, review_requested, review_request_removed : Marked as Debug log.
• Push Event: Marked as Info log.
• Issue Event: Marked as Error log.
• Release Event:
  • created, published, released : Marked as Info log.
  • edited : Marked as Warning log.
  • deleted : Marked as Error log.

Troubleshooting

Common Issues and Solutions

1. Webhook Not Triggering Events:

• Verify the Payload URL in GitHub settings.
• Ensure the events you wish to track are selected.

2. Missing Insights on Middleware Dashboard:

• Check if the webhook is active in GitHub.
• Verify that the repository and branch names are correctly entered in Middleware.

3. Security Alerts Not Captured:

• Ensure security-related events like Dependabot Alerts and Security and Analyses are enabled.

4. Incorrect Data Format:

• Set the Content type to application/json when configuring the webhook.