[FEATURE REQUEST] Add Link to GitHub repo

[Buddinski88]

Hi mag37,

I have another idea 😊

At the moment I only check if there are new versions, because I always like to check beforehand if there is a breaking change in a miner service, i.e. I look at the release notes.

Wouldn't it be cool if the link to the GitHub repo was displayed directly after checking each service?

Best regards
Buddinski88

[mag37]

It's an interesting idea, I've been trying to look into how to implement some kind of changelog scrape option, to get linked to or brief cutout from container changelogs. But there's so many different container maintainers and there's no real standard on how things are documented - so not the easiest task to achieve.

While your suggestion would be simpler than a full changelog grab for each container - it's still not simple - not all containers have a clear github page.

[Buddinski88]

That's what I suspected, so at least the link to GitHub would be helpful so that I could look it up myself.
Alternatively, I had the idea of showing the current and latest releases in the form of a version? Something like Current version 2.10 > Latest version 2.20?

[mag37]

If there was a simple way to check current VS latest version, I could remove 50% of this script 😅.

There is no real clear/standard in versioning and presenting versions in each image. Thats why currently the script checks the hashed digest of the current local image and compare it to the latest digest of the same tag - if they're not the same, its an update.
It doesn't know what version or how many versions have passed, only that the local image is not the newest.

So to GitHub links - not all images/containers have a GitHub page. And there's no automatic connection between an image repo and their GitHub page, so that would need guesswork.

There's many registries, to name a few:

• Docker Hub
• Harbor
• GitHub Container Registry
• Red Hat Quay
• Google Container Registry
• Azure Container Registry
• Amazon ECR
  and more.

Where containers are pulled from, so many of those do not have a link to a corresponding GitHub page.

If you wanna figure it out I'm happy to try to implement something - but for now it's too large a project for me to work on myself.

[Joop9]

When there are updates, I receive a (mail) notification with a list of container names where updates are available.
Is it possible to create a file with a list of container names and the corresponding link to the release note (manually, by the user) and do a lookup search for the corresponding name and paste the link into the notification?

example of lookup file:
zigbee2mqtt https://github.com/Koenkk/zigbee2mqtt/releases/latest
hass https://www.home-assistant.io/blog/categories/core/
mariadb https://mariadb.com/kb/en/release-notes/

Best regards,
Joop9

[mag37]

...
Is it possible to create a file with a list of container names and the corresponding link to the release note (manually, by the user) and do a lookup search for the corresponding name and paste the link into the notification?
...
Best regards, Joop9

It's a great suggestion! Though I don't have time to work on a solution right now but I'll try to find some time to look at it soon. I think it's smart to have the user create the list themselves - as you and me might have different names on the same container, and maybe different locations from where we find the info.

So what I'd look into is to make a function to take the list of updates available, then add a link to release notes if the container name is found in the user provided list. I'd probably make this a new file with the function inside + a way for the user to add the list in that same file. Then just source it/call it as a function from the notify.sh.