How does dockcheck's auto-update work if I run it as a cron job?

[ovizii]

I mean the fact that dockcheck will realize that there is a newer version of itself available.
I vaguely remember that it offers a prompt to let me update it.

How could I configure dockcheck to send me a notification if there is a newer version of itself?

It currently runs from a little wrapper script via cron and notifies healthchecks about its success or failure. I'm just worried what will happen if it offers to update and then the cron job will just get stuck I assume?

[mag37]

If the cron job is executed with either -a or -y for auto-update or -n for no update just check, it will skip the prompt and avoid interaction. Though it'll always print that there's an update available.
That message looks like this

New version available! <currentVersionNum> ⇒ <latestVersionNum> 
 Change Notes: <changenoteshere>

There's currently not an option to send a notification about this built in - though it's a good suggestion.
I'm not sure how it could be implemented cleanly without messing with peoples current notifications. I'll consider it when I've got time to spare!

Another option is to incorporate it into your wrapper script for now (grabbing the output above as a criteria) - let me know if you think of something :)

[yoyoma2]

Looks great. Once there is a finalized version I'll certainly contribute to the DSM template.

[mag37]

I've made a branch https://github.com/mag37/dockcheck/tree/dockcheck_upd_notify

Just made the tweak to the main script above, added the else:

  else
    [[ -n "$Notify" ]] && { [[ $(type -t dockcheck_notification) == function ]] && dockcheck_notification "$VERSION" "$LatestRelease" "$LatestChanges" || printf "Could not source notification function.\n" ; }

And then modified the Apprise and the DSM templates for now - if you'd have time to test @yoyoma2 that'd be very appreciated! No rush and any feedback/critique is welcome.
To trigger the update-message, just modify dockcheck.sh and change your local version number to a different number.

I broke out the actual sending function to a new function trigger_notification and did the title+body setup in two other functions, to not have to repeat too much code or force the user to edit multiple places.

[yoyoma2]

I'm very interested but no free time lately. Will test this on DSM when things settle down.

[yoyoma2]

It works great! For some unknown reason the \n behaves strangely on DSM so I tweaked them.

$ git diff
diff --git a/notify_templates/notify_DSM.sh b/notify_templates/notify_DSM.sh
index c95dbf3..f8402dd 100644
--- a/notify_templates/notify_DSM.sh
+++ b/notify_templates/notify_DSM.sh
@@ -68,7 +68,7 @@ dockcheck_notification() {

                MessageTitle="New version of dockcheck available on"
                # Setting the MessageBody variable here.
-               printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+               printf -v MessageBody "Installed version: $1\nLatest version: $2\n\nChangenotes: $3\n"

                trigger_notification
 }

Just nitpicking a comment but I renamed dockcheck_notification to dockcheck_notification_disabled to test turning off the new feature and the comment could include that possibility.

### Remove or comment out the following function

becomes

### Rename, remove or comment out the following function

Nice feature! I will definitely use this (actually just not turn it off) when you release it.

[mag37]

Thank you so much for testing it out :) I tried a few variants in my test environment, seems to work fine.
And yes sorry - forgot about the newlines, good corrections.

Nice feedback - that's a simpler way for some to just rename the function, I'll rephrase the comment.
I'll do some more tweaks and testing before I release it, got a OSX-support branch I need to merge to main before this :)

Once again - very glad to have your comments and testing. Thanks.

[ovizii]

Thanks for taking the time to reply. Feel free to close. I will reply here if I figure out something, otherwise I'll use it as is.

[mag37]

I'm working on it as a new feature, which I'll just embed in all the templates.
Which notification template are you currently using?

[mag37]

@ovizii and @yoyoma2 this is now merged to main - sorry for the long delay.
Hopefully it'll be useful! Thank you for brainstorming and coming with input.

[ovizii]

Thanks. I found the changelog:

Added function to send notification when dockcheck has an new update.
Will be sent when option -i together with -n or -y is used.
Manually migrate your current notification settings to a new template file.

Would you mind explaining the manual intervention needed? Ah, I think I got it. I was using the apprise notification script, I noticed there's a new version which I had to download and add my apprise settings to.

[mag37]

Ah yes - sorry maybe I should've been clearer.

In the README.md I wrote

• v0.5.7.0: Rewritten templates - now with a function to notify when there's a new Dockcheck release.
  • Manually migrate your current notify.sh settings to a new template for new functionality

But indeed - take the settings from your current notify.sh and back it up, then use the fresh template for your notification of choice and add your settings.

[ovizii]

Thanks, I didn't check the REAME :-) but I figured it out.

[yoyoma2]

This is great! I added a version to the notify_DSM.sh template as below. When dockcheck.sh has a new version, the notification will have a few extra lines if my DSM template is also outdated.

notif_ver.txt

Comments? Didn't know how to keep lines short and cleanly append to the MessageBody variable. Would you consider merging something like this? @ovizii is making a case for this kind of extra information with his previous comment. :)

Installed version: v0.5.6.1
Latest version: v0.5.7.0

Changenotes: ##Rewritten templates - now with a function to notify when theres a new Dockcheck release.

Installed NOTIFY_DSM: v0.0.1
Latest NOTIFY_DSM: v0.1

From NAS 

[mag37]

It's a good idea @yoyoma2 - I'll try to look at it soon, need to test it with a few of the other templates too in case it breaks.

Though hopefully the templates wont receive more updates ;) might be worth to add anyway. I'll look at it!

[mag37]

I've tested it in a couple more templates, looks promising!
What do you think about this formatting though - moving down the variables to just above the if to tie them together visually, with a empty line to the printf -v MessageBody bits.

		RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_DSM.sh"
		LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_DSM_VERSION/s/NOTIFY_DSM_VERSION=//p" | tr -d '"')"
		if [[ "$NOTIFY_DSM_VERSION" != "$LatestNotifyRelease" ]] ; then
			printf -v NotifyUpdate "\n\nNOTIFY_DSM update avialable:\n $NOTIFY_DSM_VERSION -> $LatestNotifyRelease \n"
			MessageBody="${MessageBody}${NotifyUpdate}"
		fi

[mag37]

This is now merged to main in #137
Thank you once again @yoyoma2 for great suggestions and feedback / testing.

[yoyoma2]

Installed and works perfectly. Thanks!