DiscordSRV

DiscordSRV

86.8k Downloads

Reduce the size of the update message

andrewkm opened this issue ยท 4 comments

commented

Why?

A 5 lined warning for every commit is over the top...

[13:36:43] [pool-125-thread-1/WARN]: [DiscordSRV] 

The current build of DiscordSRV is outdated by 3 commits! Get the latest build at your favorite distribution center.

Spigot: https://www.spigotmc.org/resources/discordsrv.18494/
Github: https://github.com/DiscordSRV/DiscordSRV/releases
Direct Download: https://get.discordsrv.com

What and How?

Config option.
Just as pretty much all other plugins do with update checkers.

Are there alternatives?

Config option.
Just as pretty much all other plugins do with update checkers.

Checks

  • I have used the search at least once to check if my idea has already been suggested and perhaps already implemented.

Anything else

No response

commented

I've been told there is a hidden option that can be added:
UpdateCheckDisabled: true

Regardless however, this option should be presented to users by default as a 5 lined logger WARN isn't something I've seen done anywhere before and is over the top for every single commit.

commented

for every commit

The extended version of the message is only logged when the version is behind older than the current release. For development builds this is reduced to a single line This build of DiscordSRV is ahead of master but behind develop. Update your development build!. The message might've made it seem as if it was for every commit, when it isn't.

this option should be presented to users by default

Disabling the update checker also disables the security check that ensures the DiscordSRV version is safe to use, this is in place in case a severe security vulnerability were to be discovered. The option isn't in the config for this reason, since unfortunately there are lots of users who don't read comments and would blindly disable it. The option is listed on the plugin's resource page and documentation, with a disclaimer about the security implications for those that do want to take the risk.

Prehaps splitting out the update reminder & security check into different options would be wise, then the update reminder option would be safer to include in the default config.

A 5 lined warning is over the top...

Fair argument, that message could easily be smaller than it is.

commented

The extended version of the message is only logged when the version is behind older than the current release. For development builds this is reduced to a single line This build of DiscordSRV is ahead of master but behind develop. Update your development build!. The message might've made it seem as if it was for every commit, when it isn't.

I'm getting the long message right now on the development branch, due to it being behind master by 2 commits (e1f7a1d, 339e5e8)

Currently building on: 3f1478f
Perhaps if right after release snapshot version update was pushed, d1c5ae3, would be cool.

commented

I'm getting the long message right now on the development branch, due to it being behind master by 2 commits

I'm usually the one to bump version + merge in the automated commits, but I wasn't around at the time of this update so I guess nobody did it. Resolved with 227b275

Didn't come to mind that the updater would trigger due to that, there's definitely some room for workflow improvements here