comroid/tc-discord-webhooks
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
This repository has been archived on 2026-04-10. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
41 commits 1 branch 1 tag 107 KiB
  • Java 100%
Find a file
Exact
Kaleidox 4de9f307ed Build URL Patch
2019-11-01 19:27:48 +01:00
.idea Build URL Patch 2019-11-01 19:27:48 +01:00
build Build URL Patch 2019-11-01 19:27:48 +01:00
tc-discord-webhooks-server Build URL Patch 2019-11-01 19:27:48 +01:00
.gitignore Initial commit 2019-06-07 20:38:47 +02:00
.travis.yml Updated CI configuration 2019-06-22 01:35:48 +02:00
docker-compose.yml Updated docker-compose 2019-06-23 16:04:51 +02:00
LICENSE Initial commit 2019-06-07 20:38:47 +02:00
pom.xml Updated meta 2019-06-23 23:47:02 +02:00
README.MD Update README.MD 2019-06-28 12:52:37 +02:00
readme.txt Initial commit 2019-06-07 20:38:47 +02:00
teamcity-plugin.xml Updated colors 2019-06-24 00:03:07 +02:00

README.MD

TeamCity Discord WebHooks Build Status

A TeamCity plugin which allows the easy creation of Discord WebHooks to notify users on a Discord server about the current build status of projects.

Features:

  • Discord Integration to get notified on a Discord server
  • Simple setup
  • Beautiful messages out of the box

System Requirements

To use this plugin you need at least TeamCity 2018.2 and Java 8.

Installation

Simply put the plugins ZIP file into the plugins directory of your TeamCity server and restart it.

You should also be able to upload the plugin using the settings page of your TeamCity installation.

Usage

The usage of this plugin is simple. Just create a WebHook for one of your Discord channels as shown here: Discord WebHook HowTo.

Then enter the WebHook URL and a Username (recommended to also enter the name!) under "My Settings & Tools" -> "Notification Rules" -> "Discord WebHook". Configure your rules as normal. You should now receive notifications on Discord!

Development

Building

The plugin is written in Java and uses Maven. So, you need the JDK and Maven to build the project.

The project can be build using the following command: mvn clean package

The installation of the build artifact is similar as described under Installation

Setting up a TeamCity Server for development

To simplify the development on the plugin, this project is bundled with a docker-compose.yml that provides everything that is required to get started.

Use the following setup ONLY for development purposes! It is not production ready!

You need:

  • A Docker compatible system
  • Docker
  • Docker-Compose

The development setup is composed using the following software:

  • TeamCity
  • TeamCity Agent

To setup the containers and start them take a look at the commands below. After the containers have been started you can open TeamCity in your browser.

Setup: docker-compose build

Start: docker-compose up -d

Stop: docker-compose stop

Finding the address of a container: docker inspect <container-name>