Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/frimtec/teamcity-inspection-notification-plugin

:cityscape: TeamCity plugin to notify new inspection violations via email to the authors contributed to the build.
https://github.com/frimtec/teamcity-inspection-notification-plugin

inspection-violations notification teamcity teamcity-plugin violation

Last synced: 7 days ago
JSON representation

:cityscape: TeamCity plugin to notify new inspection violations via email to the authors contributed to the build.

Awesome Lists containing this project

README 

        
# TeamCity-Inspection-Notification-Plugin [![setup automated][gitpod-shield]][gitpod]

[![JetBrains Plugins][jetbrains-plugin-release-shield]][jetbrains-plugin]

![Plugin Downloads][jetbrains-plugin-download-shield]



![Project Maintenance][maintenance-shield]

[![Code Coverage][codecov-shield]][codecov]

[![License][license-shield]][license]



[![Build Status][build-status-shield]][build-status]

[![Deploy Status][deploy-status-shield]][deploy-status]



---

**_Contributions Only:_**

_This project will no longer be maintained after 2024.

So all future development will come from pull requests submitted by the community.  

What I will do:_

* _review pull requests_

* _publish new releases upon request_

---



TeamCity server-side plugin that notifies committers about newly introduced code inspection violations.



![Screen shot of app](images/email.png "Screen shot of the notification")



# Installation



Install it directly from JetBrains TeamCity-Plugin-Repository [inspection-violation-notification][jetbrains-plugin].



# Configuration



## General settings

On TeamCity, as an administrator, configure the plugin on the administration tab "Inspection Violation Notification".

![Screen shot of app](images/general-settings.png "General settings page")



## Project level settings

On project level the notification mails can be disabled for a single project if required:

![Screen shot of app](images/project-settings.png "Project settings page")



# Development

The development environment is pre-configured with [![setup automated][gitpod-shield]][gitpod].



The gitpod environment provides the following tools that start automatically:

* TeamCity: TeamCity server and agent with the built and deployed plugin, configured with one build pipeline (this repository on branch "tc-test-project").

* GreenMail: mail server



The following ports of the gitpod environment are opened:



| Port  | Tool      | Usage                                                               |

|-------|-----------|---------------------------------------------------------------------|

| 8111  | TeamCity  | TeamCity-UI (use credentials for login: user=admin; password=admin) |

| 10111 | TeamCity  | JVM debug port for remote debug the plugin within TeamCity server   |

| 8080  | GreenMail | GreenMail-UI                                                        |

| 3025  | GreenMail | GreenMail SMTP                                                      |

| 3110  | GreenMail | GreenMail POP3                                                      |



Run configurations for all important tasks are pre-defined for IntelliJ-IDEA.



| Run-Config                                   | Type             | Usage                                                                       |

|----------------------------------------------|------------------|-----------------------------------------------------------------------------|

| Clean & Install                              | Maven            | Cleans and installs the complete project with maven.                        |

| Reload TC-Server                             | Maven            | Reloads TeamCity server to make recent plugin changes available.            |

| Run all tests                                | JUnit            | Runs all JUnit tests within IntelliJ-IDEA.                                  |

| Debug running TC-Server                      | Remote JVM debug | Attaches to TeamCIty server to debug the plugin.                            |

| Start mailbox logger for given email address | Application      | Runs a mailbox logger showing all received mails for a given email address. |



[gitpod-shield]: https://img.shields.io/badge/Gitpod-ready_to_code-orange?logo=gitpod

[gitpod]: https://gitpod.io/from-referrer/

[maintenance-shield]: https://img.shields.io/maintenance/no/2025.svg

[license-shield]: https://img.shields.io/github/license/frimtec/teamcity-inspection-notification-plugin.svg

[license]: https://opensource.org/licenses/Apache-2.0

[build-status-shield]: https://github.com/frimtec/teamcity-inspection-notification-plugin/workflows/Build/badge.svg

[build-status]: https://github.com/frimtec/teamcity-inspection-notification-plugin/actions?query=workflow%3ABuild

[deploy-status-shield]: https://github.com/frimtec/teamcity-inspection-notification-plugin/workflows/Deploy%20release/badge.svg

[deploy-status]: https://github.com/frimtec/teamcity-inspection-notification-plugin/actions?query=workflow%3A%22Deploy+release%22

[codecov-shield]: https://codecov.io/gh/frimtec/teamcity-inspection-notification-plugin/branch/master/graph/badge.svg?token=PA2AUVHJNI

[codecov]: https://codecov.io/gh/frimtec/teamcity-inspection-notification-plugin

[jetbrains-plugin-release-shield]: https://img.shields.io/jetbrains/plugin/v/12382

[jetbrains-plugin-download-shield]: https://img.shields.io/jetbrains/plugin/d/12382

[jetbrains-plugin]: https://plugins.jetbrains.com/plugin/12382-inspection-violation-notification