Will investigate when I have time. Also any contribution is welcomed, 😃 Adding a new notification is pretty simple if it allows to send notification via a webhook like Slack/Discord.

@robin I might be able to do this for you I have experience with the irc protocol see: https://git.polarian.dev/Polarian/ircj

I would need permission to use my own IRC wrapper as a dependency however, and I doubt you want another dependency added to OneDev :/

@polarian this is great! Just refer to current Slack/Discord implementation when you are working on IRC plugin.

by the way @robin IRC does not support webhook, the only way to do it is having a persistent socket connection to the IRC server they want the notification on which could get... messy and inefficient.

In the long run it might be better have something like this:

OneDev --> IRC notification daemon --> IRC server

OneDev and IRC notification daemon would work over HTTP webhook, and the notification daemon would (preferably) be written in a lower level language thus to be faster and more efficient to negate the lack of webhook support for IRC.

Of course this would be a very ambitious approach to doing it, but it would be a scalable and efficient method of doing it, allowing the notiifcation daemon to be isolated stops the main OneDev instance from eating too many resources, as for IRC notifications, for each server a new socket connection will need to be established and (preferably) maintained, best to keep this separate.

Be happy to know your opinion though :)

Instead of writing daemon in a different language, please implement it via a background thread in Java in same process as OneDev server. This makes OneDev maintenance (both deploying and developing) a lot easier and is one major benefit of OneDev actually. Performance is normally not a problem for self-hosted instance, and OneDev is not aiming to provide service to millions of people like GitHub/GitLab.

On how to start background thread when OneDev starts, and tear it down when OneDev stops, please check DefaultMailManager, which polls mail box periodically in a background thread to create issues/comments via email.

@robin sure, it is your codebase. I just do not recommend this, if people use many IRC servers for notifications, each server needs to maintain a connection.

There is one solution is for the bot to not keep a connection and only connect to IRC to send the notification and then leave. But this could mean constantly connecting and disconnecting which could be highly inefficient.

I do not know which one would be worse. I believe the latter approach would be the best, as IRC sends "PING" commands keeping a connection would drain bandwidth.

I am not familiar with IRC，but in a self-hosted environment, I guess there might not be many IRC servers.

Hm, seems email responses have issues parsing plaintext, and understanding my new paragraphs, meh works well enough

No hurry at all. Just take your time.

Looking at the documentation, there is two types of plugins and I am unsure which one would suit this well...

Should this be included as a builtin plugin or an external plugin?

Builtin plugin means to ship together with OneDev main program, and external plugin means to ship separately. Since you are contributing this to OneDev main program, you may create it as a builtin plugin.

Thanks :)

@jerstlouis Could you please list the features you would like included in this plugin?

@polarian Thank you very much for asking. I can think of the following basic capabilities of the top of my head:

• Notification of new commits pushed
• Notification of builds of a particular branch newly succeeding / failing
• Notification of new issues filed
• The ability to specify to which server(s) / channel(s) these notifications should happen

I imagine the capabilities should be very similar to the existing Slack & Discord plugins ?

The issue is that IRC is not one centralised instance like slack or discord, which means different channels could be contained on different servers, which could cause complications.

Do you want notifications to a specific IRC channel, or do you want it to also go to specific users directly?

@polarian personally I think IRC channel notifications would be the common use case. But for maximum flexibility make every potential users happy, ideally the plugin should allow listing servers, and for each server which channels / users to notify, and for each of these which notifications to send.

That makes this a lot more complex.

The issue is I understand the IRC protocol (or used to) very well, but I have not contributed or read any of the onedev codebase, which means it might be difficult for someone unfamiliar with the codebase to implement this feature in the most user friendly way.

I am sure Robin will help me out if I need it, but I will still give it a go at the least :)

@polarian please check the slack plugin, it allows one to specify which notification should be sent to which channel. Any question, feel free to contact me.

Thanks Robin :)

@polarian The ability to specify one (or more, if possible) server/channel combination per project for which notifications should be sent out would be a great start, if a more flexible approach adds too much complexity. A OneDev plugin bot could either remain idle in each server/channel it needs, or could join / notify / leave otherwise (that could potentially be an option as well).

@polarian slack notification tutorial in case you need to play with it: https://docs.onedev.io/tutorials/notification/slack-notification/

Thanks for the help, I have mirrored onedev to my git instance because for whatever reason onedev server has poor performance on my network, probably bad BGP routing to the host server, but I don't know. I will copy it over to code.onedev.io for a PR when I am finished :)

I would run onedev as my git instance but gitea is what I have setup, no hard feelings 😄

I have realised after reviewing the codebase of ircj (my irc wrapper I wrote a while back, as most java irc wrappers are pretty bad or do not serve my needs), and there is a lot of issues with the codebase.

I will have to postpone working on this plugin until I get the ircj codebase up to scratch, I do not want to merge sh*t code into OneDev.

I do have limited time though so @jerstlouis just because I want to implement this (mainly cause I would like to use it too :P) does not mean that it will ever be implemented, so please don't get your hopes up too much unfortunately, as I can not make any guarantees.

@polarian no problem. take your time

no worries @polarian , I greatly appreciate that you would like to help with this :) It would be nice to have this IRC notifications functionality, but we have managed fine without it for a long time :)

@jerstlouis I could write up a quick bot using the OneDev REST API to check for new versions, which could provide this functionality while I work on integrating it into OneDev?

However this still requires for me to get ircj up to scratch before I can even start working on OneDev integrations.

Probably worth supporting https://github.com/caronc/apprise syntax so it can work for lot of notifications service though it seems to be lacking IRC support.

Just a heads up, today I have patched IRCJ, I will be giving this implementation a shot over the following days. Please do not expect much from me, Onedev has a huge codebase and its my first contribution, so I am walking in the dark here.

The only advantage I have is the fact I have experience with the IRC protocol, so lets hope that is enough 😃

If you want to see the commits I am making in the following days, watch the commits to this branch:

https://onedev.polarian.dev/onedev/onedev-server/~commits?query=branch%28irc-support%29

PR into this repository will be created upon the feature being finished/working.

Thanks for working on this @polarian .

As mentioned in #1289 it would be nice to get notifications of failed/fixed builds on IRC as well.

In case it could be of any use for you as a reference, I wrote this very basic / unfinished IRC client a long time ago:

https://github.com/ecere/ecere-sdk/blob/latest/samples/net/eirc/eIRC.ec

@robin Hey I would ask if you got javadocs, but I am pretty sure the answer is no due to issue #1046 I submitted a WHILE ago.

Meh I will figure it out on my own, just will take longer than typing a Class into the javadocs and reading about all its methods and attributes and what they do.

No javadoc sorry. Unfortunately you will have to look into source to understand things. Let me know if you have questions (please be specific, I may not have time to give you things like a detailed architectural design...)

This is closed as there is no resource for this.