https://github.com/sonnyrr/branch-out-of-sync-notifier-action

📢 GitHub Action for notifying PR owners that their base branch is out-of-sync with the target one
https://github.com/sonnyrr/branch-out-of-sync-notifier-action

branch-sync ci-cd github-action github-actions github-marketplace notifier pull-request-action pull-request-check synchronization

Last synced: 14 days ago
JSON representation

📢 GitHub Action for notifying PR owners that their base branch is out-of-sync with the target one

• Host: GitHub
• URL: https://github.com/sonnyrr/branch-out-of-sync-notifier-action
• Owner: SonnyRR
• License: mit
• Created: 2024-10-28T17:02:59.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-06T17:37:16.000Z (about 2 months ago)
• Last Synced: 2024-12-22T01:13:28.164Z (14 days ago)
• Topics: branch-sync, ci-cd, github-action, github-actions, github-marketplace, notifier, pull-request-action, pull-request-check, synchronization
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📣 Branch out-of-sync notifier action 

### 🖋 Description

A github action that notifies pull-request owners that their base branch is behind the target branch via a comment on the pull request itself.

It utilizes tools such as `git` and [github-script](https://github.com/actions/github-script) to write workflows in `JavaScript`.

![image](https://github.com/user-attachments/assets/b4e7b947-fef0-4250-853e-09c48afcb98e)

### 🔨 Setup

Below is the bare minimum step in order to utilize this action, by default each of the inputs has a default value.

```yml

name: Check if base branch is synchronized

on:

  pull_request:

    types: [opened, synchronize, reopened, edited]

jobs:

  check-branch-sync:

    name: Check if head & base branches are in sync

    runs-on: ubuntu-latest

    steps:

      - name: Notify PR owner if branch is out of sync

        uses: SonnyRR/[email protected]

```

### 📩 Inputs

```yml

base-ref:

  description: "The base git reference, used for comparison."

  default: ${{ github.event.pull_request.base.ref }}

  required: true

head-ref:

  description: "The head git reference, used for comparison."

  default: ${{ github.event.pull_request.head.ref }}

  required: true

request-owner:

  description: "The owner of the pull request"

  default: ${{ github.event.pull_request.user.login }}

  required: true

request-number:

  descripton: "The pull request number"

  default: ${{ github.event.pull_request.number }}

  required: true

no-sync-label:

  description: "The label value, used for tagging PRs that shouldn't be checked"

  default: 'no-branch-sync'

  required: false

```