Prepare release

notify-rs · Jan 10, 2025 · 48541cb · 48541cb
1 parent 09a4b8a
commit 48541cb
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,29 +1,29 @@
 # Changelog
 
-v6 maintenance branch is on `v6_maintenance` after `6.1.1`
+## notify 8.0.0 (2025-01-10)
 
-v5 maintenance branch is on `v5_maintenance` after `5.2.0`
-
-v4 commits split out to branch `v4_maintenance` starting with `4.0.16`
-
-## notify 8.0.0 (unreleased)
-
-- CHANGE: raise MSRV to 1.77 [#569] [#610] **breaking**
+- CHANGE: update notify-types to version 2.0.0
+- CHANGE: raise MSRV to 1.77 **breaking**
 - FEATURE: add config option to disable following symbolic links [#635]
 - FIX: unaligned access to FILE_NOTIFY_INFORMATION [#647] **breaking**
 
 [#635]: https://github.com/notify-rs/notify/pull/635
 [#647]: https://github.com/notify-rs/notify/pull/647
 
-## notify-types 2.0.0 (unreleased)
+## notify-types 2.0.0 (2025-01-10)
 
 - CHANGE: replace instant crate with web-time [#652] **breaking**
 - CHANGE: the web-time dependency is now behind the `web-time` feature **breaking**
 
 [#652]: https://github.com/notify-rs/notify/pull/652
 
-## debouncer-full 0.5.0 (unreleased)
+## debouncer-mini 0.6.0 (2025-01-10)
+
+- CHANGE: update notify to version 8.0.0
+
+## debouncer-full 0.5.0 (2025-01-10)
 
+- CHANGE: update notify to version 8.0.0
 - CHANGE: pass `web-time` feature to notify-types
 
 ## notify-types 1.0.1 (2024-12-17)

diff --git a/Cargo.toml b/Cargo.toml
@@ -35,10 +35,10 @@ log = "0.4.17"
 mio = { version = "1.0", features = ["os-ext"] }
 web-time = "1.1.0"
 nix = "0.29.0"
-notify = { version = "7.0.0", path = "notify" }
-notify-debouncer-full = { version = "0.4.0", path = "notify-debouncer-full" }
-notify-debouncer-mini = { version = "0.5.0", path = "notify-debouncer-mini" }
-notify-types = { version = "1.0.0", path = "notify-types" }
+notify = { version = "8.0.0", path = "notify" }
+notify-debouncer-full = { version = "0.5.0", path = "notify-debouncer-full" }
+notify-debouncer-mini = { version = "0.6.0", path = "notify-debouncer-mini" }
+notify-types = { version = "2.0.0", path = "notify-types" }
 pretty_assertions = "1.3.0"
 rand = "0.8.5"
 rstest = "0.24.0"

diff --git a/README.md b/README.md
@@ -11,8 +11,10 @@ _Cross-platform filesystem notification library for Rust._
 
 
 - [Notify Documentation][notify-docs]
+- [Notify Types Documentation][notify-types-docs]
 - [Mini Debouncer Documentation][debouncer-mini-docs]
 - [Full Debouncer Documentation][debouncer-full-docs]
+- [File ID][file-id-docs]
 - [Examples][examples]
 - [Changelog][changelog]
 - [Upgrading notify from v4](UPGRADING_V4_TO_V5.md)
@@ -35,7 +37,8 @@ and others.
 
 ## License
 
-Notify is licensed under the [CC Zero 1.0][cc0].  
+notify is licensed under the [CC Zero 1.0][cc0].    
+notify-types is licensed under the [MIT] or [Apache-2.0][apache] license.  
 notify-debouncer-mini is licensed under the [MIT] or [Apache-2.0][apache] license.  
 notify-debouncer-full is licensed under the [MIT] or [Apache-2.0][apache] license.  
 file-id is licensed under the [MIT] or [Apache-2.0][apache] license.
@@ -68,6 +71,8 @@ Originally created by [Félix Saparelli] and awesome [contributors].
 [deno]: https://github.com/denoland/deno
 [docket]: https://iwillspeak.github.io/docket/
 [notify-docs]: https://docs.rs/notify/latest/notify/
+[notify-types-docs]: https://docs.rs/notify-types/latest/notify-types/
+[file-id-docs]: https://docs.rs/file-id/latest/file-id/
 [fsnotify]: https://github.com/fsnotify/fsnotify
 [handlebars-iron]: https://github.com/sunng87/handlebars-iron
 [hotwatch]: https://github.com/francesca64/hotwatch

diff --git a/notify-debouncer-full/Cargo.toml b/notify-debouncer-full/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "notify-debouncer-full"
-version = "0.4.0"
+version = "0.5.0"
 description = "notify event debouncer optimized for ease of use"
 documentation = "https://docs.rs/notify-debouncer-full"
 authors = ["Daniel Faust <[email protected]>"]

diff --git a/notify-debouncer-full/src/lib.rs b/notify-debouncer-full/src/lib.rs
@@ -12,15 +12,15 @@
 //!
 //! ```toml
 //! [dependencies]
-//! notify-debouncer-full = "0.3.1"
+//! notify-debouncer-full = "0.5.0"
 //! ```
 //!
 //! In case you want to select specific features of notify,
 //! specify notify as dependency explicitly in your dependencies.
 //! Otherwise you can just use the re-export of notify from debouncer-full.
 //!
 //! ```toml
-//! notify-debouncer-full = "0.3.1"
+//! notify-debouncer-full = "0.5.0"
 //! notify = { version = "..", features = [".."] }
 //! ```
 //!
@@ -49,7 +49,11 @@
 //!
 //! The following crate features can be turned on or off in your cargo dependency config:
 //!
+//! - `serde` passed down to notify-types, off by default
+//! - `web-time` passed down to notify-types, off by default
 //! - `crossbeam-channel` passed down to notify, off by default
+//! - `macos_fsevent` passed down to notify, off by default
+//! - `macos_kqueue` passed down to notify, off by default
 //! - `serialization-compat-6` passed down to notify, off by default
 //!
 //! # Caveats

diff --git a/notify-debouncer-mini/Cargo.toml b/notify-debouncer-mini/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "notify-debouncer-mini"
-version = "0.5.0"
+version = "0.6.0"
 description = "notify mini debouncer for events"
 documentation = "https://docs.rs/notify-debouncer-mini"
 authors = ["Aron Heinecke <[email protected]>"]

diff --git a/notify-debouncer-mini/src/lib.rs b/notify-debouncer-mini/src/lib.rs
@@ -4,13 +4,13 @@
 //!
 //! ```toml
 //! [dependencies]
-//! notify-debouncer-mini = "0.4.1"
+//! notify-debouncer-mini = "0.6.0"
 //! ```
 //! In case you want to select specific features of notify,
 //! specify notify as dependency explicitly in your dependencies.
 //! Otherwise you can just use the re-export of notify from debouncer-mini.
 //! ```toml
-//! notify-debouncer-mini = "0.4.1"
+//! notify-debouncer-mini = "0.6.0"
 //! notify = { version = "..", features = [".."] }
 //! ```
 //!
@@ -45,8 +45,10 @@
 //!
 //! The following crate features can be turned on or off in your cargo dependency config:
 //!
+//! - `serde` passed down to notify-types, off by default
 //! - `crossbeam-channel` passed down to notify, off by default
-//! - `serde` enables serde support for events, off by default
+//! - `macos_fsevent` passed down to notify, off by default
+//! - `macos_kqueue` passed down to notify, off by default
 //! - `serialization-compat-6` passed down to notify, off by default
 //!
 //! # Caveats

diff --git a/notify-types/Cargo.toml b/notify-types/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "notify-types"
-version = "1.0.0"
+version = "2.0.0"
 description = "Types used by the notify crate"
 documentation = "https://docs.rs/notify-types"
 readme = "../README.md"

diff --git a/notify/Cargo.toml b/notify/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "notify"
-version = "7.0.0"
+version = "8.0.0"
 description = "Cross-platform filesystem notification library"
 documentation = "https://docs.rs/notify"
 readme = "../README.md"

diff --git a/notify/src/lib.rs b/notify/src/lib.rs
@@ -4,7 +4,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! notify = "7.0.0"
+//! notify = "8.0.0"
 //! ```
 //!
 //! If you want debounced events (or don't need them in-order), see [notify-debouncer-mini](https://docs.rs/notify-debouncer-mini/latest/notify_debouncer_mini/)
@@ -24,7 +24,7 @@
 //! Events are serializable via [serde](https://serde.rs) if the `serde` feature is enabled:
 //!
 //! ```toml
-//! notify = { version = "7.0.0", features = ["serde"] }
+//! notify = { version = "8.0.0", features = ["serde"] }
 //! ```
 //!
 //! # Known Problems

diff --git a/release_checklist.md b/release_checklist.md
@@ -4,8 +4,9 @@ Specifically the notify version.
 
 - update CHANGELOG.md
 - update README.md
-- update notify/lib.rs
-- update notify/cargo.toml examples/Cargo.toml examples/hot_reload_tide/Cargo.toml
-  - bump version number on the root Cargo.toml and examples
-- maybe update notify-debouncer-mini/Cargo.toml
-- maybe update notify-debouncer-full/Cargo.toml
+- update Cargo.toml and src/lib.rs for:
+  - file-id
+  - notify
+  - notify-debouncer-full
+  - notify-debouncer-mini
+  - notify-types