https://github.com/dsabre/jenkins-alert

A simple Jenkins watcher in python
https://github.com/dsabre/jenkins-alert

jenkins

Last synced: about 1 month ago
JSON representation

A simple Jenkins watcher in python

• Host: GitHub
• URL: https://github.com/dsabre/jenkins-alert
• Owner: dsabre
• Created: 2023-07-21T11:56:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-03T09:56:19.000Z (over 1 year ago)
• Last Synced: 2023-08-03T10:55:45.548Z (over 1 year ago)
• Topics: jenkins
• Language: Python
• Homepage:
• Size: 81.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jenkins-alert

A simple Jenkins watcher in python.

## Requirements

- [notify-send](https://ss64.com/bash/notify-send.html "notify-send")

- [tabulate](https://pypi.org/project/tabulate/ "tabulate")

- [tqdm](https://tqdm.github.io "tqdm")

- [pynput](https://pypi.org/project/pynput/ "pynput")

## Installation

```bash

pip install -r requirements.txt

```

## Usage

Just run: ```python3 new_script.py``` and follow instructions to create a new script or manually create a script inside the "scripts" directory with the following code:

```bash

#!/bin/bash

# script configuration

JENKINS_PROJECT="project-name|split-by-pipes-if-you-have-groups"

JENKINS_EXTRA_JOBS="extra-jobs|split-by-pipes" # can be empty

JENKINS_URL="http://your-jenkins-url.example"

JENKINS_USERNAME="username"

JENKINS_PASSWORD="password"

STOP_ON_NOT_RUNNING=1 # 1 or 0

SLEEP_TIME=5 # info refresh timing expressed in seconds

SHOW_URLS=1 # 1 or 0

SHOW_PROGRESS_BAR=1 # 1 or 0

DECORATED_OUTPUT=1 # 1 or 0

DO_SOUNDS=1 # 1 or 0

TELEGRAM_BOT_TOKEN="" # can be empty

TELEGRAM_CHAT_ID="" # can be empty

TELEGRAM_MESSAGE="" # can be empty (if empty but telegram is configured, will be used a standard message)

# end script configuration

SCRIPT_PATH="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )/../main.py"

python3 "$SCRIPT_PATH" "$JENKINS_PROJECT" "$JENKINS_EXTRA_JOBS" "$JENKINS_URL" "$JENKINS_USERNAME" "$JENKINS_PASSWORD" $SLEEP_TIME $SHOW_URLS "$TELEGRAM_BOT_TOKEN" "$TELEGRAM_CHAT_ID" "$TELEGRAM_MESSAGE" $DECORATED_OUTPUT $STOP_ON_NOT_RUNNING $SHOW_PROGRESS_BAR $DO_SOUNDS

```

### TELEGRAM_MESSAGE available tokens

- `{PROJECT}`

- `{JOB_NAME}`

- `{STATUS}`: status of the last job builded