💡 Summary

Add a way to notify users when a new version of ScubaGear is available for use when they run the tool.

Motivation and context

Users get the best possible assessment by using the latest version of the ScubaGear tool, with the latest baselines. Later versions incorporate updates, fixes, and enhancements. A mechanism to notify users of a new version when running ScubaGear.

Implementation notes

The notification to users should be done in a way so as not to be disruptive, but informative. Initial thought is during initialization, ScubaGear would make a query to either GitHub or PowerShell gallery to determine the latest release of ScubaGear. On success, it would compare the running version to the latest version and if the running version is less than latest, print an information message to the console noting that a new version of ScubaGear is available and providing a reference to the download/install documentation (aka link).
On a failure, due to inability to retrieve the latest version, it would simply not print a message.
Also recommend adding a configuration option or parameter to silence/turn off the latest version check for users that don't want to see it in their output.

Optionally, the version mismatch could also be written to the JSON and HTML report in some fashion. But this may not be desirable.

Acceptance criteria

How do we know when this work is done?

• ScubaGear includes a notification to users when a newer version of ScubaGear is available for download/installation
• Users can configure the notification to be either on or off, and it is on by default