https://github.com/jefeish/merge-guard-app

A GitHub Probot app that enforces merge commit comment standards.
https://github.com/jefeish/merge-guard-app

Last synced: 2 months ago
JSON representation

A GitHub Probot app that enforces merge commit comment standards.

• Host: GitHub
• URL: https://github.com/jefeish/merge-guard-app
• Owner: jefeish
• License: mit
• Created: 2024-11-13T14:59:53.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-06T01:43:18.000Z (6 months ago)
• Last Synced: 2025-02-01T16:27:08.261Z (4 months ago)
• Language: JavaScript
• Size: 84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build Status](https://img.shields.io/github/actions/workflow/status/jefeish/merge-guard-app/ci.yml?branch=main)

![License](https://img.shields.io/github/license/jefeish/merge-guard-app)

![Version](https://img.shields.io/github/v/release/jefeish/merge-guard-app)

![Languages](https://img.shields.io/github/languages/top/jefeish/merge-guard-app)

![Repo Size](https://img.shields.io/github/repo-size/jefeish/merge-guard-app)

# Merge Guard App

A GitHub Probot app that enforces merge commit comment standards.

## Introduction

This app ensures that pull requests merges include key information, like a JIRA ticket ID, in the `merge-commit` message. 

Developers might include this info in individual commits, but it’s not guaranteed to appear in the final `merge-commit`. 

By default, GitHub uses the PR title as the `merge-commit` message, but if the PR has multiple commits, the branch name is used instead. 

This app validates that the `merge-commit` includes the required information, and can block merges if the check fails, enforcing this rule via branch protection.

### NOTE: This app provides an alternative solution to using GitHub Actions.