Skip to content

v1.0.0

Choose a tag to compare

@outarde outarde released this 24 Aug 18:11
· 125 commits to main since this release

v1.0.0

This is a meaningful update! There are three main new features:

  • Individual time zones for rooms.
  • Creating reminders without a command at the beginning of a message and only by mention in group chats.
  • Uploading your translation files.

Warning

This is a major release, so it contains breaking changes:

  • Switch to UTC time format in the database. Database migration is not provided. Delete the database file from the bot data folder. After restart it will create a new one.
  • Switch to the configuration file config.yml for all bot settings not related to connecting to the Matrix server. Read about the new settings and interactive configurator.

Setup Checklist

  • Create a settings file config.yml in the folder associated with the bot container.
  • Set the default time zone in the settings for all users of your server. To change the time zone in a room, send to the bot a command /tz <timezone-code>. For time zone codes, use the TZ identifier database.
  • Remove all previous settings with the BOT_ prefix from .env and the database file, if any.

🚀 Features and Enhancements

  • 7d05ab9 New settings file config.yml.
  • 1856af0 Aliases for commands.
  • 371c9c6 Options on_command and on_mention to activate bot only by command and by mention in group rooms.
  • 0f56295 Interactive setup for config with config-setup command.
  • cd0cbac Ability to load external localizatiion file.
  • 69d14c1 New slash / prefix for commands.
  • ccd0844 Reminders are stored with UTC time.
  • a9bcfab Room time zone.
  • 3249fe6 Send welcome message when bot receives an invitation to the room.

🐛 Bug Fixes

  • d173569 Save config file with interactive setup.
  • f5cf941, 0281850 Default times and timezone validation for config setup.
  • 9872681 MATRIX_HOMESERVER now is optional for starting bot CLI and will cause an error only if bot has no saved session in sessions folder
  • 5a502da Seasonal time changes error handling.

🌐 Localization

  • 35fbd5f Some of localization keys are updated.
  • 9c43dd9 Multilingual prepositions.
  • b95b983 New, extended welcome message.
  • 64f69ec New translations for time zone settings.

📕 Documentation

💻 Code Refactoring

  • 371c9c6, 0f56295 New main.rs state-architecture with AppConfig, BotRuntime and BotContext.
  • 371c9c6 Use text_markdown method instead of pulldown-cmark crate parser.
  • 47c6872, e949257 MonthManager and then I18nManager.
  • 3249fe6 SettingsManager.

Full Changelog: https://github.com/outarde/reminder-bot/compare/v0.4.0...v1.0.0