https://github.com/bsramin/slack-jenkins-bot

A small utility to be able to command Jenkins via Slack
https://github.com/bsramin/slack-jenkins-bot

jenkins jenkins-ci slack slack-api slack-bot slackbot trigger

Last synced: 25 days ago
JSON representation

A small utility to be able to command Jenkins via Slack

• Host: GitHub
• URL: https://github.com/bsramin/slack-jenkins-bot
• Owner: bsramin
• License: mit
• Created: 2021-03-17T23:08:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-02T23:03:08.000Z (over 2 years ago)
• Last Synced: 2024-09-30T18:01:27.015Z (about 1 month ago)
• Topics: jenkins, jenkins-ci, slack, slack-api, slack-bot, slackbot, trigger
• Language: TypeScript
• Homepage:
• Size: 3.59 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# SLACK <-> JENKINS BOT

[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/bsramin/slack-jenkins-bot/blob/main/LICENSE.txt)

This bot allows you to safely and _effectively_ run jobs on jenkins _directly from Slack_, also receiving end-of-execution notifications.

Through permissions it is possible to configure, for each single job, who has the right to execute it from slack and at any time it is possible to check the last jobs performed.

## USAGE

After the [installation](documentation/install.md), from Slack simply run the commands.

Eg.

  `/do job1`

  `/do job2 param1=value1`

  `/do job3 param1=value1 param2=value2`

  `/requests` (the view the latest requests)

### Jenkins Response

If your `request` needs to show on slack an output generated by the Jenkins job, you just have to generate an [artifact](documentation/slackResponse.txt) which contains this output.

Use this snippet:

```groovy

slackfields = '"title1","content1","false"\n"title2","content2","false"'

writeFile(file: 'slackResponse.txt', text: slackfields)

archiveArtifacts artifacts: 'slackResponse.txt', onlyIfSuccessful: true

```

The last element of `slackfields` (boolean) identifies the full-width (true) or half-width (false) block on slack in order to stack two of them

## SETUP

Follow the [setup instruction](documentation/install.md)

## FAQ

### How do I access Jenkins server from behind a router?

You can use [ngrok](https://ngrok.com/) or [webhookrelay](https://webhookrelay.com/)

# LICENSE

The MIT License (MIT)

Copyright (c) 2021 Ramin Banihashemi

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.