clean up/unify Cargo metadata + prep metrics-exporter-dogstatsd for release

tobz · tobz · commit 1ce169ea172e · 2025-01-19T14:53:36.000-05:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,6 +11,12 @@ members = [
   "metrics-util",
 ]
 
+[workspace.package]
+edition = "2021"
+license = "MIT"
+repository = "https://github.com/metrics-rs/metrics"
+homepage = "https://github.com/metrics-rs/metrics"
+
 [workspace.dependencies]
 ahash = { version = "0.8", default-features = false }
 aho-corasick = { version = "1", default-features = false }
diff --git a/metrics-exporter-dogstatsd/CHANGELOG.md b/metrics-exporter-dogstatsd/CHANGELOG.md
@@ -10,4 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Genesis.
+- Genesis of the new version of this crate. This version of the exporter is a successor to the original
+  `metrics-exporter-dogstatsd` exporter written by [Valentino Volonghi](https://github.com/dialtone), and starts after
+  the last version of that crate (`0.8.0`) to indicate the SemVer-incompatible changes that have been made. This new
+  crate is MIT licenses just as the original one was. The old code can be found
+  [here](https://github.com/dialtone/metrics-exporter-dogstatsd).
diff --git a/metrics-exporter-dogstatsd/Cargo.toml b/metrics-exporter-dogstatsd/Cargo.toml
@@ -1,7 +1,19 @@
 [package]
 name = "metrics-exporter-dogstatsd"
-version = "0.1.0"
-edition = "2021"
+version = "0.9.0"
+edition = { workspace = true}
+rust-version = "1.71.1"
+
+description = "A metrics-compatible exporter for sending metrics to the Datadog Agent."
+license = { workspace = true }
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+repository = { workspace = true }
+homepage = { workspace = true }
+documentation = "https://docs.rs/metrics-exporter-dogstatsd"
+readme = "README.md"
+
+categories = ["development-tools::debugging"]
+keywords = ["metrics", "telemetry", "dogstatsd", "Datadog"]
 
 [dependencies]
 bytes = { version = "1", default-features = false }
diff --git a/metrics-exporter-dogstatsd/README.md b/metrics-exporter-dogstatsd/README.md
@@ -0,0 +1,25 @@
+# metrics-exporter-dogstatsd
+
+[![conduct-badge][]][conduct] [![downloads-badge][] ![release-badge][]][crate] [![docs-badge][]][docs] [![license-badge][]](#license)
+
+[conduct-badge]: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg
+[downloads-badge]: https://img.shields.io/crates/d/metrics-exporter-dogstatsd.svg
+[release-badge]: https://img.shields.io/crates/v/metrics-exporter-dogstatsd.svg
+[license-badge]: https://img.shields.io/crates/l/metrics-exporter-dogstatsd.svg
+[docs-badge]: https://docs.rs/metrics-exporter-dogstatsd/badge.svg
+[conduct]: https://github.com/metrics-rs/metrics/blob/master/CODE_OF_CONDUCT.md
+[crate]: https://crates.io/crates/metrics-exporter-dogstatsd
+[docs]: https://docs.rs/metrics-exporter-dogstatsd
+
+__metrics-exporter-dogstatsd__ is a `metrics`-compatible exporter sending metrics to the Datadog Agent.
+
+## previous versions (0.8.0 and earlier) of this crate
+
+Up until the 0.9.0 release, this crate was based on a different codebase
+(http://github.com/dialtone/metrics-exporter-dogstatsd) written by [Valentino Volonghi](http://github.com/dialtone). The
+new version (0.9.0) are officially supported by the metrics-rs team, and are SemVer-incompatible with the previous
+versions.
+
+## code of conduct
+
+**NOTE**: All conversations and contributions to this project shall adhere to the [Code of Conduct][conduct].
diff --git a/metrics-exporter-prometheus/Cargo.toml b/metrics-exporter-prometheus/Cargo.toml
@@ -1,15 +1,14 @@
 [package]
 name = "metrics-exporter-prometheus"
 version = "0.16.1"
-authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
 edition = "2018"
 rust-version = "1.71.1"
 
-license = "MIT"
-
 description = "A metrics-compatible exporter for sending metrics to Prometheus."
-homepage = "https://github.com/metrics-rs/metrics"
-repository = "https://github.com/metrics-rs/metrics"
+license = { workspace = true }
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+repository = { workspace = true }
+homepage = { workspace = true }
 documentation = "https://docs.rs/metrics-exporter-prometheus"
 readme = "README.md"
 
diff --git a/metrics-exporter-prometheus/README.md b/metrics-exporter-prometheus/README.md
@@ -11,7 +11,7 @@
 [crate]: https://crates.io/crates/metrics-exporter-prometheus
 [docs]: https://docs.rs/metrics-exporter-prometheus
 
-__metrics-exporter-prometheus__ is a `metrics`-compatible exporter that serves a Prometheus scrape endpoint.
+__metrics-exporter-prometheus__ is a `metrics`-compatible exporter for sending metrics to Prometheus.
 
 ## code of conduct
 
diff --git a/metrics-exporter-tcp/Cargo.toml b/metrics-exporter-tcp/Cargo.toml
@@ -1,15 +1,14 @@
 [package]
 name = "metrics-exporter-tcp"
 version = "0.11.0"
-authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
 edition = "2018"
 rust-version = "1.71.1"
 
-license = "MIT"
-
 description = "A metrics-compatible exporter that outputs metrics to clients over TCP."
-homepage = "https://github.com/metrics-rs/metrics"
-repository = "https://github.com/metrics-rs/metrics"
+license = { workspace = true }
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+repository = { workspace = true }
+homepage = { workspace = true }
 documentation = "https://docs.rs/metrics-exporter-tcp"
 readme = "README.md"
 
diff --git a/metrics-observer/Cargo.toml b/metrics-observer/Cargo.toml
@@ -1,15 +1,14 @@
 [package]
 name = "metrics-observer"
 version = "0.4.0"
-authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
 edition = "2018"
 rust-version = "1.74.0"
 
-license = "MIT"
-
 description = "Text-based UI for metrics-exporter-tcp."
-homepage = "https://github.com/metrics-rs/metrics"
-repository = "https://github.com/metrics-rs/metrics"
+license = { workspace = true }
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+repository = { workspace = true }
+homepage = { workspace = true }
 documentation = "https://docs.rs/metrics"
 readme = "README.md"
 
diff --git a/metrics-tracing-context/Cargo.toml b/metrics-tracing-context/Cargo.toml
@@ -1,16 +1,15 @@
 [package]
 name = "metrics-tracing-context"
 version = "0.18.0"
-authors = ["MOZGIII <mike-n@narod.ru>"]
 edition = "2018"
 rust-version = "1.71.1"
 
-license = "MIT"
-
 description = "A crate to use tracing context as metrics labels."
-homepage = "https://github.com/metrics-rs/metrics"
-repository = "https://github.com/metrics-rs/metrics"
-documentation = "https://docs.rs/metrics"
+license = { workspace = true }
+authors = ["MOZGIII <mike-n@narod.ru>"]
+repository = { workspace = true }
+homepage = { workspace = true }
+documentation = "https://docs.rs/metrics-tracing-context"
 readme = "README.md"
 
 categories = ["development-tools::debugging"]
diff --git a/metrics-util/Cargo.toml b/metrics-util/Cargo.toml
@@ -1,15 +1,14 @@
 [package]
 name = "metrics-util"
 version = "0.19.0"
-authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
 edition = "2018"
 rust-version = "1.71.1"
 
-license = "MIT"
-
 description = "Helper types/functions used by the metrics ecosystem."
-homepage = "https://github.com/metrics-rs/metrics"
-repository = "https://github.com/metrics-rs/metrics"
+license = { workspace = true }
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+repository = { workspace = true }
+homepage = { workspace = true }
 documentation = "https://docs.rs/metrics-util"
 readme = "README.md"
 
diff --git a/metrics/Cargo.toml b/metrics/Cargo.toml
@@ -1,15 +1,14 @@
 [package]
 name = "metrics"
 version = "0.24.1"
-authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
 edition = "2018"
 rust-version = "1.71.1"
 
-license = "MIT"
-
 description = "A lightweight metrics facade."
-homepage = "https://github.com/metrics-rs/metrics"
-repository = "https://github.com/metrics-rs/metrics"
+license = { workspace = true }
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+repository = { workspace = true }
+homepage = { workspace = true }
 documentation = "https://docs.rs/metrics"
 readme = "README.md"
 
