v2.0.0 - Modular Perfection

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

v2.0.0 Beta 1

🛑 NOTE: This release in BETA! It is functional but don't expect perfection at this moment. Please open issues with any problems you encounter. 🛑

Welcome to 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!

Improvements ⚙️

• There has been a complete overhaul of the configuration setup and stock checking logic to 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, 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.

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 requires these.

Remember, this is a beta release. It's working, but there might still be a couple small bugs you encounter. Please open issues as you see them so they can be tackled for a final release.

Thank you!

Full Changelog: v1.1.3...v2.0.0-beta.1

v1.1.3 - Discord Implementation Bugfix

There was an issue identified with some parts of the Discord.js implementation that caused errors during initial startup of a new bot when using Discord mode. This was due to some of the implementation being out of date and no longer working with the new Discord.js v14 API. This release corrects the issues using a new implementation.

Fixes 🔧

• Fixed incompatible Discord.js implementation that was causing issues on initial bot setup/start.

Updates ⏫

• Discord.js upgraded to the latest v14 patch version (14.8.0 at time of this release).
• Upgraded all other packages to latest versions.

Full Changelog: v1.1.2...v1.1.3

v1.1.2 - Minor Maintenance and Updates

This small patch release is focused on just keeping things up to date and working well. There are no noticeable functional changes to the bot here.

Updates ⏫

• Discord.js upgraded to the latest v14 version. Refactored bot codebase to work with v14 coming from v13.
• Upgraded all other packages to latest versions.
• Bumped up minimum version requirement for Node.js to be in line with Discord.js.

Full Changelog: v1.1.1...v1.1.2

v1.1.1 - Critical Bugfix

Important patch update that fixes stock check logic! There was an issue with how the actual In-Stock status of the Pi models was being checked. It would not trigger if they did actually come in stock because the condition being checked was not looking for the right text. This has been fixed here.

Fixes 🔧

• CRITICAL: Fixed incorrect in-stock condition check

Other 🗒️

• Added some startup messages that show when bot starts. This is so that if you run with only the Slack bot enabled, you will still receive some sign that the bot is started and running rather than just staring at a blank terminal 😉. When Discord is enabled it will show its own startup messages, so this doesn't apply there.

Full Changelog: v1.1.0...v1.1.1

v1.1.0 - Slack is Here! + Refinements

Welcome to the second release of the Adafruit Pi4 Stock Bot! There's lots of good stuff in this version, including the addition of Slack bot support and several improvements and fixes. Let's dig in and see what major things have changed!

NEW! 🎉

• Support for running a Slack bot: You can now choose to run either Slack or Discord bots, or even BOTH!
• Sleep mode: An option that can be enabled which suspends update queries overnight while Adafruit isn't doing any restocks
• PM2 Process Support: There is now a process.json file which can used with PM2 to run the bot as a managed process

Improvements ⚙️

• Discord roles are now created in the server only for models that are enabled to be watched in the config file
• Discord notification messages now have timestamps provided in the footer for easier time tracking
• Huge improvements to the setup and usage documentation in the readme, it's now easier than ever to get up and going!

Fixes 🔧

• Fixed Discord client attempting to log in even when Discord was not enabled in the config

New Contributors 🙌

Thanks for your help!

• @aapple12314 made their first contribution in PR #2
• @cpapplefamily made their first contribution in PR #4

Full Changelog: v1.0.0...v1.1.0

v1.0.0 - Initial Release - Discord Version

This is the first public release of the bot. Everything is in a functional state and documentation is in place to get it up and going.
This release contains the Discord version only! A Slack capable version will come in the next release.

Having problems? Be sure to open an issue and let me know!

I wish you luck in getting a pi, and I hope this tool helps :)


Full Changelog of Commits: https://github.com/EthyMoney/Adafruit-Pi4-Stock-Bot/commits/v1.0.0