https://github.com/gitbucket/gitbucket-notifications-plugin

A GitBucket plug-in to provides email notifications feature
https://github.com/gitbucket/gitbucket-notifications-plugin

gitbucket gitbucket-plugin scala

Last synced: about 2 months ago
JSON representation

A GitBucket plug-in to provides email notifications feature

• Host: GitHub
• URL: https://github.com/gitbucket/gitbucket-notifications-plugin
• Owner: gitbucket
• License: apache-2.0
• Created: 2017-05-26T06:01:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T00:22:19.000Z (2 months ago)
• Last Synced: 2024-10-29T01:23:45.387Z (2 months ago)
• Topics: gitbucket, gitbucket-plugin, scala
• Language: Scala
• Homepage:
• Size: 94.7 KB
• Stars: 20
• Watchers: 8
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# gitbucket-notifications-plugin [![build](https://github.com/gitbucket/gitbucket-notifications-plugin/workflows/build/badge.svg?branch=master)](https://github.com/gitbucket/gitbucket-notifications-plugin/actions?query=workflow%3Abuild+branch%3Amaster)

This plug-in provides notifications feature on GitBucket.

| Plugin version | GitBucket version |

|:---------------|:------------------|

| 1.11.x         | 4.37.x            |

| 1.10.x         | 4.35.x            |

| 1.9.x          | 4.34.x            |

| 1.8.x          | 4.32.x - 4.33.x   |

| 1.7.x          | 4.30.x - 4.31.x   |

| 1.6.x          | 4.26.x - 4.29.x   |

| 1.5.x          | 4.23.x - 4.25.x   |

| 1.4.x          | 4.19.x - 4.22.x   |

| 1.2.x, 1.3.x   | 4.17.x - 4.18.x   |

| 1.1.x          | 4.16.x            |

| 1.0.x          | 4.15.x            |

## Features

The current version of plug-in provides features such as:

- Pre-included notifications (see below)

- Watching repositories

- Subscribing to issues

### Pre-included notifications

GitBucket can send email notifications to users if this feature is enabled by an administrator.

You'll automatically receive these notifications when:

- Opened issues (new issues, new pull requests)

    - When a record is inserted into the ```ISSUE``` table

- Comments

    - Among the records in the ```ISSUE_COMMENT``` table, them to be counted as a comment (i.e. the record ```ACTION``` column value is "comment" or "close_comment" or "reopen_comment") are inserted

- Updated state (close, reopen, merge)

    - When the ```CLOSED``` column value is updated

Notified users are as follows:

- individual repository's owner

- group members of group repository

- collaborators

- participants

However, the person performing the operation is excluded from the notification.

### Watching repositories

When you watch a repository, you get notifications.

You can unwatch a repository to receive notifications when participating.

If you won't receive any notifications, you select Ignoring.

### Subscribing to issues

You can subscribe or unsubscribe to individual issues.

## Build from source

Run `sbt assembly` and copy generated `/target/scala-2.13/gitbucket-notifications-plugin-x.x.x.jar` to `~/.gitbucket/plugins/` (If the directory does not exist, create it by hand before copying the jar), or just run `sbt install`.