diff --git a/buildSrc/README.md b/buildSrc/README.md new file mode 100644 index 0000000..ad9c554 --- /dev/null +++ b/buildSrc/README.md @@ -0,0 +1,18 @@ +# Build Sources + +> This module included into gradle build files, so it has utilities such dependencies constants, dependencies versions, project modules and custom plugins.
+> Btw I like this solution for dependencies instead introduced in gradle 7.0 version catalogs etc. + +## Structure + +All kinds of shortcuts is unpackaged (including due to imports doesn't work in `plugins` block): + +[AppInfo](https://github.com/y9san9/prizebot/blob/dev/buildSrc/src/main/kotlin/AppInfo.kt) - basic application info
+[Dependencies](https://github.com/y9san9/prizebot/blob/dev/buildSrc/src/main/kotlin/Dependencies.kt) - dependencies string constants
+[Version](https://github.com/y9san9/prizebot/blob/dev/buildSrc/src/main/kotlin/Version.kt) - all kinds of versions extracted here
+[Plugins](https://github.com/y9san9/prizebot/blob/dev/buildSrc/src/main/kotlin/Plugins.kt) - gradle plugins string constants
+[Modules](https://github.com/y9san9/prizebot/blob/dev/buildSrc/src/main/kotlin/Modules.kt) - project modules shortcuts + +Otherwise, plugins are packaged: + +[Deploy](https://github.com/y9san9/prizebot/blob/dev/buildSrc/src/main/kotlin/me/y9san9/deploy/Deploy.kt) - plugin for convenient deployment bot to server via ssh with `systemctl restart` diff --git a/buildSrc/src/main/kotlin/AppInfo.kt b/buildSrc/src/main/kotlin/AppInfo.kt index 0f8be13..e89e051 100644 --- a/buildSrc/src/main/kotlin/AppInfo.kt +++ b/buildSrc/src/main/kotlin/AppInfo.kt @@ -1,4 +1,4 @@ object AppInfo { const val PACKAGE = "me.y9san9.prizebot" - const val VERSION = "1.1-beta" + const val VERSION = "2.0" } diff --git a/db-migrations/README.md b/db-migrations/README.md new file mode 100644 index 0000000..5ccd772 --- /dev/null +++ b/db-migrations/README.md @@ -0,0 +1,8 @@ +# DB Migrations +> **Note**: This is module with migrations implementation, for actual migrations see [it](https://github.com/y9san9/prizebot/tree/dev/bot/src/main/kotlin/me/y9san9/prizebot/database/migrations) + +## Structure + +The migrations are designed with [MigrationsApplier](https://github.com/y9san9/prizebot/blob/dev/db-migrations/src/main/kotlin/me/y9san9/db/migrations/MigrationsApplier.kt) as main entity. It performs all migrations in recursion-way (because personally I hate cycles and immutable state) + +[MigrationsStorage](https://github.com/y9san9/prizebot/blob/dev/db-migrations/src/main/kotlin/me/y9san9/db/migrations/MigrationsStorage.kt) is a simple set-get table model for tracking schema version