Giter Site home page Giter Site logo

grimmy / tc-discord-webhooks Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pascal-zarrad/tc-discord-webhooks

0.0 2.0 0.0 118 KB

A TeamCity plugin which adds Discord WebHook support to TeamCity!

Home Page: https://plugins.jetbrains.com/plugin/12608-tc-discord-webhooks

License: MIT License

Java 100.00%

tc-discord-webhooks's Introduction

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>

tc-discord-webhooks's People

Contributors

licho1 avatar pascal-zarrad avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.