jenkins-infra / ircbot Goto Github PK

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

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

For detailed examples see Jenkinsfile located in this repository.

Testing the bot locally

Preconditions:

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

Setting up the environment:

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)

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.

ircbot's People

Contributors

Stargazers

Watchers

ircbot's Issues

Feature request: ability to archive repository

Example of use case: jenkins-infra/helpdesk#2088 (comment)

Add updatecli manifest

List repository collaborators

To check whether a user is added to a repository but not in a team, we could make use of GHRepository#listCollaborators() to obtain a list of all members added to a specific repository.

Add timestamps in logs

Looking at IRCBot pod logs, I've noticed they aren't timestamped.

Could timestamps be added to the logs?

Support adding contributor to multiple repos at one time

This could just be an extension of the existing command that allows for a comma separated list and iterates over the repos.

Create jenkinsci/memkins on github for oleg-nenashev fails

I believe it's because of jira / github issues support being added, currently you need to specify:
https://github.com/jenkins-infra/ircbot/blob/master/src/main/java/org/jenkinsci/backend/ircbot/IrcListener.java#L184

Either docs or bot should be updated to reflect https://www.jenkins.io/projects/infrastructure/ircbot/

Update deployment instructions in README.md

The current deployment instructions for the ircbot don't seem to be correct (e.g., there is no longer a helm chart for it?). It would be good for someone with the information to update the deployment instructions area of the README.md if there is anything that needs to be done to get the updated bot deployed. If there are no longer any manual steps that need to happen, it would be good to remove the deployment instructions from the README.md

Adding committers to multiple repositories does not work

@slide Am I using this wrong?

According to the docs, this should be the correct syntax, no? https://www.jenkins.io/projects/infrastructure/ircbot/#github-repo-management

Don't attempt deployment on ci.jenkins.io

Every build fails at the moment, because executing the build logic provided by the makefile attempts to deploy the image to the docker hub: https://ci.jenkins.io/job/Infra/job/ircbot/job/main/14/

Maybe we can outsource the logic to the Jenkinsfile and use a isInfra() condition to check, whether the pipeline is executed on ci.j or infra.ci.j. Depending on the result, the pipeline deploys the image to the docker hub. There's no need to attempt that on ci.j, given we can't deploy from there.

For comparison, the build succeeds on infra.ci: https://infra.ci.jenkins.io/job/docker-jobs/job/ircbot/job/main/

Adding one person to several repositories spams replies

While picking up jenkins-infra/repository-permissions-updater#3024 with the syntax outlined in the documentation, I wasn't able to add Mark to multiple repositories at once.

Looking at the first 2 bot responses, it appears that only one parameter is considered at a time.

No idea what happened after the third time, I guess the bot gone crazy.

Changing Jira component default assignee doesn't work

I attempted to change and remove a component's default assignee with the bot commands, but the assignee wasn't updated on Jira's end

The component is still assigned to someone else, neither the person specified, nor unassigned: https://issues.jenkins.io/projects/JENKINS?selectedItem=com.atlassian.jira.jira-projects-plugin:components-page&contains=oracle-cloud-infra&isActivePressed=true

Context: jenkins-infra/helpdesk#2497 (comment)

Use pipeline-library to automatically publish docker image

Apply https://github.com/jenkins-infra/pipeline-library/blob/master/resources/io/jenkins/infra/docker/README.adoc
Add repository to infra.ci (either rename it as docker-account-app or amend infra.ci's config )
- [-] jenkins-infra/kubernetes-management#3031
~~[ ] Migrate Jenkinsfile to Jenkinsfile_k8s~~ Not neede anymore
Remove job from trusted.ci.jenkins.io

Support for Java 17

Only tests will need an update, the dependencies to build the project should support Java 11 and 17 out of the box.
Although, powermock doesn't support JUnit 5, but we can probably get a rid of it and use mockito 4 with JUnit or hamcrest assertion.

Add command to add topics to a repository

It may be handy to have a command to add or remove topics from a GitHub repository.

jenkins-infra / ircbot Goto Github PK

ircbot's Introduction

JIRA/GitHub management IRCBot

Deployment

License

Developer guide

Reusing IRCBot in non-Jenkins project

Building the bot

Testing the bot locally

ircbot's People

Contributors

Stargazers

Watchers

Forkers

ircbot's Issues

Recommend Projects

Recommend Topics

Recommend Org