Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 2.8 KB

README.md

File metadata and controls

71 lines (48 loc) · 2.8 KB
Raw

JIRA/GitHub management IRCBot

Build Status Docker Pulls

This IRC bot sits on #jenkins as jenkins-admin and allow users to create/fork repositories on GitHub, etc. More info: Jenkins IRC Bot Page

Deployment

This repo is containerized (image available on docker hub), then deployed to our infrastructure via Helmfile.

You can find the helm chart and instructions to install it in jenkins-infra/helm-charts.

License

MIT License

Developer guide

This section contains some info for developers.

Reusing IRCBot in non-Jenkins project

The bot is designed to be used in Jenkins, but it can be adjusted in other projects, which use the similar infrastructure (GitHub, IRC, JIRA). Adjustements can be made via System properties. These properties are located and documented in the org.jenkinsci.backend.ircbot.IrcBotConfig class.

Several examples are provided below.

Building the bot

  1. Use Maven to build the project and to run the unit tests.
  2. Then use Dockerfile to create a Docker image

For detailed examples see Jenkinsfile located in this repository.

Testing the bot locally

Preconditions:

  1. You have a JIRA Test Project, where you have admin permissions.
  2. You have a GitHub Organization with Administer permissions

Setting up the environment:

  1. Setup Github credentials in the ~/.github file
  • Format: Java properties
  • Entries to set: login and password
  • It's also possible oauth and endpoint properties (see github-api)
  1. Setup JIRA credentials in the ~/.jenkins-ci.org file
  • Format: Java properties
  • Entries to set: userName and password

Running the bot for testing:

java -Dircbot.name=test-ircbot \ 
-Dircbot.channels="#jenkins-ircbot-test" \ 
-Dircbot.testSuperUser="${YOUR_IRC_NAME}" \ 
-Dircbot.github.organization="jenkinsci-infra-ircbot-test" \
-Dircbot.jira.url=${JIRA_URL} \
-Dircbot.jira.defaultProject=TEST \
-Dorg.slf4j.simpleLogger.showDateTime=true \
-Dorg.slf4j.simpleLogger.dateTimeFormat="yyyy-MM-dd HH:mm:ss:SSS Z"
-jar target/ircbot-2.0-SNAPSHOT-bin/ircbot-2.0-SNAPSHOT.jar

After executing this command the bot should connect to your IRC chat.