diff --git a/CHANGELOG.md b/CHANGELOG.md index fd6b3d90d..c69fcf82d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## Unreleased + +* `loco doctor` now checks for app-specific minimum dependency versions. This should help in upgrades. `doctor` also supports "production only" checks which you can run in production with `loco doctor --production`. This, for example, will check your connections but will not check dependencies. +* + ## v0.12.0 This release have been primarily about cleanups and simplification. diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index aeca31b39..95074a7cf 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,3 +1,21 @@ +## Blessed depdenencies maintenance and `loco doctor` + +Loco contain a few major and "blessed" dependencies, these appear **both** in an app that was generated at the surface level in their `Cargo.toml` and in the core Loco framework. + +If stale, may require an upgrade as a must. + +Example for such dependencies: + +* The `sea-orm-cli` - while Loco uses `SeaORM`, it uses the `SeaORM` CLI to generate entities, and so there may be an incompatibility if `SeaORM` has a too large breaking change between their CLI (which ships separately) and their framework. +* `axum` +* etc. + +This is why we are checking these automatically as part of `loco doctor`. + +We keep minimal version requirements for these. As a maintainer, you can update these **minimal** versions, only if required in [`doctor.rs`](src/doctor.rs). + + + ## Running Tests Before running tests make sure that: diff --git a/docs-site/content/docs/infrastructure/deployment.md b/docs-site/content/docs/infrastructure/deployment.md index b9ae14394..e960be42f 100644 --- a/docs-site/content/docs/infrastructure/deployment.md +++ b/docs-site/content/docs/infrastructure/deployment.md @@ -137,6 +137,13 @@ auth: ``` +## Running `loco doctor` + +You can run `loco doctor` in your server to check the connection health of your environment. + +```sh +$ myapp doctor --production +``` ## Generate diff --git a/examples/demo/tests/cmd/cli.trycmd b/examples/demo/tests/cmd/cli.trycmd index 035e830b2..2a2f4c4b2 100644 --- a/examples/demo/tests/cmd/cli.trycmd +++ b/examples/demo/tests/cmd/cli.trycmd @@ -131,6 +131,7 @@ $ demo_app-cli doctor ✅ SeaORM CLI is installed ✅ DB connection: success ✅ redis queue: queue connection: success +✅ Dependencies ```