https://github.com/jenkins-infra/ircbot

Jenkins IRCbot
https://github.com/jenkins-infra/ircbot

docker hacktoberfest ircbot jenkins jenkins-infra

Last synced: 3 months ago
JSON representation

Jenkins IRCbot

• Host: GitHub
• URL: https://github.com/jenkins-infra/ircbot
• Owner: jenkins-infra
• License: mit
• Created: 2010-11-24T06:09:37.000Z (about 14 years ago)
• Default Branch: main
• Last Pushed: 2023-11-01T01:33:55.000Z (over 1 year ago)
• Last Synced: 2024-08-10T11:03:12.025Z (6 months ago)
• Topics: docker, hacktoberfest, ircbot, jenkins, jenkins-infra
• Language: Java
• Homepage: https://jenkins.io/projects/infrastructure/ircbot/
• Size: 590 KB
• Stars: 23
• Watchers: 10
• Forks: 27
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JIRA/GitHub management IRCBot

[![Build Status](https://ci.jenkins.io/job/Infra/job/ircbot/job/main/badge/icon)](https://ci.jenkins.io/job/Infra/job/ircbot/job/main/)

[![Docker Pulls](https://img.shields.io/docker/pulls/jenkinsciinfra/ircbot)](https://hub.docker.com/r/jenkinsciinfra/ircbot)

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](https://jenkins.io/projects/infrastructure/ircbot/)

## Deployment

This repo is containerized (image available [on docker hub](https://hub.docker.com/r/jenkinsciinfra/ircbot/)), then [deployed to our infrastructure](https://github.com/jenkins-infra/kubernetes-management/blob/ccf43dc44f10e813ec50d9c3358b3ae0b4482f8b/clusters/privatek8s.yaml#L137-L144) via Helmfile.

You can find the helm chart and instructions to install it in [jenkins-infra/helm-charts](https://github.com/jenkins-infra/helm-charts/tree/main/charts/ircbot).

## License

[MIT License](https://opensource.org/licenses/mit-license.php)

## 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

0. Use Maven to build the project and to run the unit tests.

0. Then use Dockerfile to create a Docker image

For detailed examples see [Jenkinsfile](Jenkinsfile) located in this repository.

### Testing the bot locally

Preconditions:

0. You have a JIRA **Test** Project, where you have admin permissions.

1. You have a GitHub Organization with ```Administer``` permissions

Setting up the environment:

0. 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](https://github.com/kohsuke/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:

```sh

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.