-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f0394cf
commit 68b641a
Showing
1 changed file
with
25 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,44 @@ | ||
# TeleJenkins [![Build Status](https://ci.jenkins.io/job/Plugins/job/telegram-notifications-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/telegram-notifications-plugin/job/master/) | ||
|
||
![TeleJenkins Japan Style](https://pp.vk.me/c636926/v636926471/193d1/fARBefBcfzs.jpg) | ||
![TeleJenkins Logo](https://pp.vk.me/c636926/v636926471/193d1/fARBefBcfzs.jpg) | ||
|
||
This plugin allows **Jenkins** to send notifications via **telegram** bot. | ||
|
||
--- | ||
|
||
#### Installation | ||
1. Download latest release | ||
2. [Manually install](https://jenkins.io/doc/book/managing/plugins/#advanced-installation) *.hpi* plugin to your jenkins | ||
## Installation | ||
|
||
#### Basic usage | ||
##### Create bot | ||
### Build from source | ||
1. To build a plugin, run `mvn install`. This will create the file *./target/telegram-notifications.hpi* | ||
2. [Manually install](https://jenkins.io/doc/book/managing/plugins/#advanced-installation) plugin to your Jenkins | ||
|
||
### Download an hpi | ||
1. Download _telegram-notifications-*.hpi_ release [here](https://github.com/jenkinsci/telegram-notifications-plugin/releases) | ||
2. [Manually install](https://jenkins.io/doc/book/managing/plugins/#advanced-installation) plugin to your Jenkins | ||
|
||
### Plugin Manager | ||
1. Go to *<your_jenkins>/pluginManager/available* | ||
2. Find and install **Telegram Bot** | ||
|
||
|
||
## Basic usage | ||
### Create bot | ||
1. Find BotFather in Telegram ([@BotFather](https://t.me/@BotFather)) | ||
2. Send */newbot* command | ||
3. Enter bot name and bot username | ||
3. Follow the instructions | ||
|
||
##### Global config | ||
### Global config | ||
1. Open the Jenkins global config | ||
2. Paste your bot name and username to according textfields | ||
3. In filed Usernames fill names of users who can get Jenkins messages (separated by spaces) | ||
4. Save | ||
2. Paste your bot *name* and *token* to according textfields | ||
|
||
##### Subscribe for Jenkins messages | ||
### Subscribe for Jenkins messages | ||
1. In telegram find your bot and send */start* command | ||
2. Send */sub* command | ||
|
||
##### Manage your job | ||
1. Add build-step (or post build-step) | ||
### Manage your job | ||
1. Add a build step and/or a post build step | ||
2. Fill the message (you can use environment variables and simple Markdown) | ||
3. Save your job | ||
|
||
##### Use in Pipeline | ||
telegramSend 'Hello World' | ||
### Use in Pipeline | ||
`telegramSend 'Hello World'` | ||
|