From 588c5de1ee409b7ce78f029c93e2bb163403c206 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Sun, 25 Oct 2026 16:09:45 +1300 Subject: [PATCH] Release `core-console` v0.1.0. Release: v0.1.0 --- Cargo.lock | 2 +- Cargo.toml | 7 +++++-- bake/src/bake_generated_tasks/mod.rs | 4 +++- readme.md | 31 ++++++++++++++++++++++------ releases.md | 3 +-- src/lib.rs | 1 - 6 files changed, 35 insertions(+), 13 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 9771d6c..c33b54b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -156,7 +156,7 @@ checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600" [[package]] name = "core-console" -version = "0.0.0" +version = "0.1.0" dependencies = [ "futures-lite", "log", diff --git a/Cargo.toml b/Cargo.toml index c60111c..75d6edb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,14 @@ [package] name = "core-console" -version = "0.0.0" +version = "0.1.0" edition = "2024" rust-version = "1.85" license = "MIT" repository = "https://github.com/core-rs/core-console" +documentation = "https://docs.rs/core-console" description = "Automatic terminal and JSON diagnostics for tracing" +keywords = ["logging", "tracing", "console", "diagnostics"] +categories = ["development-tools::debugging"] readme = "readme.md" include = ["src/**", "context/**", "design/**", "examples/**", "Cargo.toml", "readme.md", "license.md", "releases.md"] @@ -20,7 +23,7 @@ manifest = "bake/Cargo.toml" reviewers = ["core-rs/maintainers"] [dependencies] -serde_json = { version = "1", features = ["arbitrary_precision"] } +serde_json = { version = "1.0.154", features = ["arbitrary_precision"] } tracing = { version = "0.1.44", default-features = false, features = ["std"] } tracing-error = "0.2.1" tracing-log = "0.2" diff --git a/bake/src/bake_generated_tasks/mod.rs b/bake/src/bake_generated_tasks/mod.rs index 1c8a325..0ab6c92 100644 --- a/bake/src/bake_generated_tasks/mod.rs +++ b/bake/src/bake_generated_tasks/mod.rs @@ -1,3 +1,5 @@ -// Generated by `cargo bake --regenerate`; do not edit. +// Released under the MIT License. +// Copyright, 2026, by Samuel Williams. +// Generated by `cargo bake --regenerate`; do not edit. use core_project as _; diff --git a/readme.md b/readme.md index 50e7bc9..66514d3 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# Core Console +# `core-console` Automatic terminal and JSON diagnostics for Rust applications using `tracing`. @@ -6,10 +6,10 @@ Console chooses coloured, human-readable output when stderr is a terminal and ne ## Usage -This is a local prototype. Add the checkout and `tracing` to an application: +Add Console and `tracing` to an application: ```sh -cargo add core-console --path ../core-console +cargo add core-console cargo add tracing ``` @@ -88,11 +88,30 @@ cargo clippy --workspace --all-targets -- -D warnings cargo bake test:coverage --all-targets true ``` -### Agent Context +## Releasing -Run `cargo bake agent:context:install` to install shared context and skills. Use `cargo bake agent:context:list` and `cargo bake agent:context:show` to discover guidance. Follow `agents.md` and the installed skills under `.agents/skills/`. +Prepare a release with `cargo bake cargo:version:patch` (or `minor`, `major`, or `bump --version X.Y.Z`), commit it with a `Release: vVERSION` trailer, then run `cargo bake cargo:release` and open a pull request. After review and merge, GitHub Actions publishes the release when the configured `crates-io` environment approves it, then creates or updates the matching GitHub Release from `releases.md`. Follow the shared [Releasing skill](https://github.com/core-rs/core-project/blob/main/context/releasing.md) for the standard process. ## Releases -See [releases.md](releases.md) for the initial implementation status. + +See [releases.md](releases.md) for the full release history. +### v0.1.0 + +- Choose terminal text or newline-delimited JSON automatically for `tracing` events. +- Preserve typed fields, span context, and error causes through composable or scoped subscribers. +- Capture failures with optional OS backtraces and logical span traces for later reporting. +- Follow Rust logging conventions with panicking `init` and fallible `try_init` functions and builder methods. + + +## See Also + +- [`tracing`](https://docs.rs/tracing) provides structured events and spans. +- [`tracing-subscriber`](https://docs.rs/tracing-subscriber) provides subscriber composition and filtering. + +## Contributing + +Please open an issue or pull request on [GitHub](https://github.com/core-rs/core-console). + +Run `cargo bake agent:context:install` to install shared context and skills for development. Use `cargo bake agent:context:list` and `cargo bake agent:context:show` to discover guidance. Follow `agents.md` and the installed skills under `.agents/skills/`. diff --git a/releases.md b/releases.md index 546d651..8ba19be 100644 --- a/releases.md +++ b/releases.md @@ -1,9 +1,8 @@ # Releases -## Unreleased +## v0.1.0 - Choose terminal text or newline-delimited JSON automatically for `tracing` events. - Preserve typed fields, span context, and error causes through composable or scoped subscribers. - Capture failures with optional OS backtraces and logical span traces for later reporting. - Follow Rust logging conventions with panicking `init` and fallible `try_init` functions and builder methods. - diff --git a/src/lib.rs b/src/lib.rs index b0192a0..a94ba12 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -10,7 +10,6 @@ //! core_console::init(); //! tracing::info!(connections = 3_u64, "Server started"); //! ``` - mod as_console_error; mod console; mod console_fields;