Prepare for 0.1.1 (#13)

- Add a CHANGELOG - Tidy up some Cargo.toml features - Increase the stable version in CI (but not the MSRV) - Bump version numbers in Cargo.toml - Synchronise version numbers in Cargo.toml; this is a simplifying decision which has been true so far, and we can change it later if needed --------- Co-authored-by: Kaur Kuut <[email protected]>
linebender · Jun 14, 2024 · f8b46a9 · f8b46a9
1 parent 8dff9e9
commit f8b46a9
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 17 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,7 +4,7 @@ env:
   # come automatically. If the version specified here is no longer the latest stable version,
   # then please feel free to submit a PR that adjusts it along with the potential clippy fixes.
   # When updating this, also update RUST_DOCS_COMPILE_VER below to the same version
-  RUST_STABLE_VER: "1.77" # In quotes because otherwise (e.g.) 1.70 would be interpreted as 1.7
+  RUST_STABLE_VER: "1.79" # In quotes because otherwise (e.g.) 1.70 would be interpreted as 1.7
   # The version of rustc we use to test that doc examples compile.
   # This is required because we depend on the unstable `-Zdoctest-xcompile`.
   # See https://github.com/rust-lang/rust/issues/64245

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,47 @@
+<!-- Instructions
+
+This changelog follows the patterns described here: <https://keepachangelog.com/en/>.
+
+Subheadings to categorize changes are `added, changed, deprecated, removed, fixed, security`.
+
+-->
+
+# Changelog
+
+The latest published Android Trace release is [0.1.1](#011---2024-06-14) which was released on 2024-06-14.
+You can find its changes [documented below](#011---2024-06-14).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.1.1] - 2024-06-14
+
+### Added
+
+- License files in Cargo packages ([#12] by [@DJMcNab])
+- This changelog ([#13] by [@DJMcNab])
+
+### Changed
+
+- Badges to match Linebender standard ([#11] by [@DJMcNab])
+
+### Fixed
+
+## [0.1.0] - 2024-04-03
+
+- Initial release
+
+[@DJMcNab]: https://github.com/DJMcNab
+
+[#11]: https://github.com/linebender/android_trace/pull/11
+[#12]: https://github.com/linebender/android_trace/pull/12
+[#13]: https://github.com/linebender/android_trace/pull/13
+
+[Unreleased]: https://github.com/linebender/android_trace/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/linebender/android_trace/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/linebender/android_trace/releases/tag/v0.1.0
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,15 +11,21 @@ rust-version = "1.77"
 repository = "https://github.com/linebender/android_trace"
 edition = "2021"
 
-[workspace.dependencies]
-android_trace = { path = "./android_trace", version = "0.1.0", default-features = false }
+# Android Trace version, also used by other packages which want to mimic Android Trace's version.
+# Right now those packages include android_trace and tracing_android_trace.
+#
+# NOTE: When bumping this, remember to also bump the aforementioned other packages'
+#       version in the dependencies section at the bottom of this file.
+version = "0.1.1"
+
+[workspace.lints]
+rust.unreachable_pub = "warn"
+rust.unsafe_op_in_unsafe_fn = "warn"
+rust.missing_debug_implementations = "warn"
+rust.missing_docs = "warn"
 
-[workspace.lints.rust]
-unreachable_pub = "warn"
-unsafe_op_in_unsafe_fn = "warn"
-missing_debug_implementations = "warn"
-missing_docs = "warn"
+clippy.doc_markdown = "warn"
+clippy.semicolon_if_nothing_returned = "warn"
 
-[workspace.lints.clippy]
-doc_markdown = "warn"
-semicolon_if_nothing_returned = "warn"
+[workspace.dependencies]
+android_trace = { path = "./android_trace", version = "0.1.1", default-features = false }
diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ Tracing spans for [Vello](https://github.com/linebender/vello) shown in Android
 </figcaption>
 </figure>
 
+Significant changes are documented in [the changelog].
+
 ## Tracing Android Trace [tracing_android_trace](./tracing_android_trace)
 
 Tracing Android Trace provides several [`tracing_subscriber::Layer`][]s for Android NDK Tracing, using `ATrace_beginSection` and `ATrace_endSection`.
@@ -72,3 +74,4 @@ dual licensed as above, without any additional terms or conditions.
 [rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct
 [NDK Tracing]: https://developer.android.com/ndk/reference/group/tracing
 [`tracing_subscriber::Layer`]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/layer/trait.Layer.html
+[the changelog]: CHANGELOG.md
diff --git a/android_trace/Cargo.toml b/android_trace/Cargo.toml
@@ -4,9 +4,8 @@ description = "Support for Android NDK Tracing"
 categories = ["api-bindings", "os"]
 keywords = ["android", "logging", "atrace", "ndk"]
 readme = true
-# When updating, also update the version in the dependency in the workspace Cargo.toml
-version = "0.1.0"
 
+version.workspace = true
 license.workspace = true
 rust-version.workspace = true
 repository.workspace = true

diff --git a/android_trace/README.md b/android_trace/README.md
@@ -29,6 +29,8 @@ a sibling to this file's parent folder-->
 See [tracing_android_trace](https://crates.io/crates/tracing_android_trace)
 for an integration of this with [`tracing`](https://docs.rs/tracing/latest/tracing/).
 
+Significant changes are documented in [the changelog][].
+
 ## Quickstart
 
 Add a dependency on Android Trace:
@@ -120,6 +122,7 @@ Licensed under either of
 at your option.
 </div>
 
+[the changelog]: https://github.com/linebender/android_trace/blob/main/CHANGELOG.md
 [rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct
 [LICENSE-APACHE]: LICENSE-APACHE
 [LICENSE-MIT]: LICENSE-MIT

diff --git a/rustfmt.toml b/rustfmt.toml
@@ -0,0 +1,3 @@
+use_field_init_shorthand = true
+newline_style = "Unix"
+# TODO: imports_granularity = "Module" - Wait for this to be stable.
diff --git a/tracing_android_trace/Cargo.toml b/tracing_android_trace/Cargo.toml
@@ -8,8 +8,8 @@ categories = [
 ]
 keywords = ["android", "logging", "tracing"]
 readme = true
-version = "0.1.0"
 
+version.workspace = true
 license.workspace = true
 rust-version.workspace = true
 repository.workspace = true
@@ -18,7 +18,6 @@ edition.workspace = true
 [lints]
 workspace = true
 
-
 [dependencies]
 tracing-subscriber = { version = "0.3.18", default-features = false, features = [
     "std",

diff --git a/tracing_android_trace/README.md b/tracing_android_trace/README.md
@@ -35,6 +35,8 @@ Tracing spans for [Vello](https://github.com/linebender/vello) shown in Android
 </figcaption>
 </figure>
 
+Significant changes are documented in [the changelog][].
+
 ## Quickstart
 
 Add a dependency on Android Trace (and on [`tracing_subscriber`][]).
@@ -152,6 +154,7 @@ at your option.
 
 [NDK Tracing]: https://developer.android.com/ndk/reference/group/tracing
 [`android_trace`]: https://crates.io/crates/android_trace
+[the changelog]: https://github.com/linebender/android_trace/blob/main/CHANGELOG.md
 [rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct
 [LICENSE-APACHE]: LICENSE-APACHE
 [LICENSE-MIT]: LICENSE-MIT