# lark-notice-plugin

**Repository Path**: xm721806280/lark-notice-plugin

## Basic Information

- **Project Name**: lark-notice-plugin
- **Description**: Lark Notice Plugin (原飞书插件Feishu Notice Plugin) 是一个用于 Jenkins 的构建通知插件，可以将 Jenkins 构建过程以及结果通知推送到 Lark、飞书、钉钉 协作平台。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://721806280.github.io/lark-notice-plugin-doc
- **GVP Project**: No

## Statistics

- **Stars**: 43
- **Forks**: 12
- **Created**: 2022-08-15
- **Last Updated**: 2025-09-22

## Categories & Tags

**Categories**: jenkins-plugins

**Tags**: lark, 飞书, 钉钉, Jenkins

## README

<div align="center">
   <p align="center">
      <a href="https://721806280.github.io/lark-notice-plugin-doc">
          <img src="src/main/webapp/images/logo.png" alt="logo">
      </a>
   </p>
   <p align="center">
      <img src="https://img.shields.io/badge/JDK-17-success" alt="JDK">
      <img src="https://img.shields.io/badge/Jenkins-2.492-blue.svg" alt="License">
      <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
      <img src="https://img.shields.io/badge/Author-xm.z-success" alt="Author">
   </p>

   <div align="center">
      <a href="https://721806280.github.io/lark-notice-plugin-doc">
        <img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=600&size=26&pause=1000&multiline=true&repeat=false&random=true&width=665&height=46&lines=Lark+-+Jenkins+builds+notification+plugins" alt="Typing SVG" />
      </a>
   </div>
</div>

## 🌐 Plugin Introduction

`lark-notice-plugin` is a `build notification robot` notification plug-in for `Jenkins`, which can push the `Jenkins`
build process and result notifications to the `Lark`、`Feishu` and `DingTalk` collaboration platforms.
Multiple notification timings can be configured,
including `when the build starts`, `build interruption`, `build failure`, `when the build succeeds`,
`build instability`,
etc.
Supports many different types of messages,
including `text messages`, `picture messages`, `group business card messages`, `rich text messages`, `card messages`;
At the same time, the plug-in also provides the functions of `custom template` and `variables', allowing you to
customize the content and format of notification messages according to your own needs.

## 📝 Using documentation

> Please refer to [official document](https://721806280.github.io/lark-notice-plugin-doc)

## 🧑‍💻 Development Services

Add `hpi:run` to the startup configuration in the `maven` control panel on the right side of `IDEA`:

### Remote debugging (Remote JVM DEBUG)

#### 1. Command line mode start

> 1. `set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=5005,suspend=n`
> 2. `mvn hpi:run -Djetty.port=8080`

#### 2. IDEA starts

> 1. Open the `maven` panel in `idea`, the `hpi` plugin under `Plugins`
> 2. Right click on `hpi:run` and select `Modify Run Configuration..` to set
> 3. Click `Modify Options` and select `Add VM Options` option
> 4. Input at `VM options`: `-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=5005,suspend=n`
> 5. Click the Run button to start executing the `maven` command (do not run in `Debug` mode)

#### 3. Remote JVM DEBUG

> 1. Open `Run/Debug Configurations` and click `Add New Configuration` and select `Remote JVM DEBUG`
> 2. After configuring the port, `Run` runs the debugger
> 3. The console prints information after startup: `Listening for transport dt_socket at address: 5005`

## ✅ Development Agreement

1. Use [Alibaba Java Coding Guidelines](https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/)
   Verify code specifications.
2. Use the [Google Style Guide](https://github.com/google/styleguide) to unify the code style.

> `IDEA`
>
download [intellij-java-google-style.xml](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)
> Import via `Settings` -> `Editor` `Code Style`.

## 🔍️ Related Links

- [Plugin tutorial](https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial#Plugintutorial-SettingUpEnvironment)
- [Jenkins plug-in development journey: from idea to release in two days (Part 1)](https://jenkins-zh.cn/wechat/articles/2019/05/2019-05-06-jenkins-plugin-develop-within-two-days-part01/)
- [Jenkins plug-in development journey: from idea to release in two days (Part 2)](https://jenkins-zh.github.io/wechat/articles/2019/05/2019-05-08-jenkins-plugin-develop-within-two-days-part02/)

## ⭐ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=721806280/lark-notice-plugin&type=Date)](https://www.star-history.com/#721806280/lark-notice-plugin&Date)