Skip to content

v2.0.0 - Modular Perfection

Latest
Compare
Choose a tag to compare
@EthyMoney EthyMoney released this 17 Nov 19:52
· 6 commits to main since this release

Welcome to the second major release of the Adafruit Pi Stock Bot! A lot has changed since the beginning of this project, including the launch of a new Pi! Hello Raspberry Pi 5! 🥳

This release brings lots of technical under-the-hood improvements as well as new features like support for watching other models of Pies, like the new Pi 5 for example. Let's dig in!

NEW! 🎉

  • Support for other models: No longer are you stuck with only looking at Pi 4 models, now you can watch others too! Currently supported by default are the Pi 5 series, the Pi 4 series, and even the Pi Zero series.
  • Support for custom messages: You now have control over the contents of alert messages using the new modular configuration design. See below for details!
  • Docker Support: That's right! The bot is now able to be ran as a Docker container using either the official hosted image on Docker Hub, or by building your own. See the Docker section of the readme for details!
  • New configuration option: You can now skip sending alerts for currently in-stock models at bot startup using the new skipStartupAlerts config option.

Improvements ⚙️

  • There has been a complete overhaul of the configuration setup and stock checking logic to make things more efficient and allow for more modular configuration and addition/changing of models and their settings.
  • There is now a models.json file that lists out all of the models the bot is capable of tracking and all metadata attributes for them that the bot uses when checking and notifying. This file gives control over things like the page URL, names, roles, colors, images, and more, all in one place.
  • The bot program no longer has any hard-coded settings or values, it is now a modular design controlled by the config files. This new approach makes it easy to add new models to the bot and make changes to any fields and settings on them.
  • The config.json file is now better organized with subsections and clearer naming. This makes it easier to understand and modify.
  • Greatly simplified and improved the stock checking logic thanks to the new modular streamlined design. It's fast, efficient, and robust.
  • Several improvements to instructions and details within the readme, check it out!

Breaking Changes💥

  • V2 uses an entirely new configuration scheme. There is an updated config.json and a new models.json file. These are not compatible with other versions of the bot, and the new versions of the bot require these.

Thank you!

Full Changelog: v1.1.3...v2.0.0

Full Changelog Since Beta: v2.0.0-beta.1...v2.0.0