Skip to content

Commit

Permalink
[meta] update readme + changelog, handle proptest std (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshowers authored Jan 15, 2025
1 parent ca6c4ef commit 648d4ee
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 97 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## [1.2.0] - 2025-01-14

### Added

- New, optional feature `proptest1` enables support for generating random instances of UUIDs. Currently, v4 UUIDs are always generated.

### Changed

- MSRV updated to Rust 1.67.

## [1.1.3] - 2024-11-07

### Added
Expand Down Expand Up @@ -75,6 +85,7 @@ Documentation improvements.

Initial release.

[1.2.0]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.2.0
[1.1.3]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.3
[1.1.2]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.2
[1.1.1]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.1
Expand Down
95 changes: 0 additions & 95 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ dropshot = "0.10.0"
expectorate = "1.0.6"
newtype-uuid = { path = "crates/newtype-uuid" }
prettyplease = "0.2.22"
proptest = "1.5.0"
# Ideally we'd let you use no-std proptest, but proptest requires either the std
# or the no_std option to be set. It won't compile without one of those two set.
proptest = { version = "1.5.0", features = ["std"], default-features = false }
schemars = "0.8.17"
serde = "1"
serde_json = "1.0.115"
Expand Down
2 changes: 1 addition & 1 deletion crates/newtype-uuid/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ uuid.workspace = true

[features]
default = ["uuid/default", "std"]
std = ["uuid/std", "alloc"]
std = ["alloc", "uuid/std"]
alloc = []
v4 = ["uuid/v4"]
serde = ["dep:serde", "uuid/serde"]
Expand Down
2 changes: 2 additions & 0 deletions crates/newtype-uuid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ permits conversions between typed and untyped UUIDs.
- `schemars08`: Enables support for generating JSON schemas via schemars 0.8. *Not enabled by
default.* Note that the format of the generated schema is **not currently part** of the stable
API, though we hope to stabilize it in the future.
- `proptest1`: Enables support for generating `proptest::Arbitrary` instances of UUIDs. *Not enabled by default.*

## Minimum supported Rust version (MSRV)

Expand All @@ -113,6 +114,7 @@ each minor version are:

* Version **1.0.x**: Rust 1.60.
* Version **1.1.x**: Rust 1.61. This permits `TypedUuid<T>` to have `const fn` methods.
* Version **1.2.x**: Rust 1.67, required by some dependency updates.

## Alternatives

Expand Down
2 changes: 2 additions & 0 deletions crates/newtype-uuid/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@
//! - `schemars08`: Enables support for generating JSON schemas via schemars 0.8. *Not enabled by
//! default.* Note that the format of the generated schema is **not currently part** of the stable
//! API, though we hope to stabilize it in the future.
//! - `proptest1`: Enables support for generating `proptest::Arbitrary` instances of UUIDs. *Not enabled by default.*
//!
//! # Minimum supported Rust version (MSRV)
//!
Expand All @@ -106,6 +107,7 @@
//!
//! * Version **1.0.x**: Rust 1.60.
//! * Version **1.1.x**: Rust 1.61. This permits `TypedUuid<T>` to have `const fn` methods.
//! * Version **1.2.x**: Rust 1.67, required by some dependency updates.
//!
//! # Alternatives
//!
Expand Down

0 comments on commit 648d4ee

Please sign in to comment.