Skip to content

Commit

Permalink
Merge pull request #4 from sebastienrousseau/feat/serde_yml
Browse files Browse the repository at this point in the history
0.0.10
  • Loading branch information
sebastienrousseau authored May 30, 2024
2 parents 2bf9497 + 81a7cac commit 9abdc79
Show file tree
Hide file tree
Showing 42 changed files with 4,275 additions and 359 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
build
Cargo.lock
Icon?
public/test_site/test.txt
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ name = "serde_yml"
readme = "README.md"
repository = "https://github.com/sebastienrousseau/serde_yml"
rust-version = "1.60"
version = "0.0.9"
version = "0.0.10"
include = [
"/CONTRIBUTING.md",
"/LICENSE-APACHE",
Expand All @@ -40,7 +40,7 @@ include = [
[dependencies]
indexmap = "2.2.6"
itoa = "1.0.11"
libyml = "0.0.1"
libyml = "0.0.3"
log = { version = "0.4.21", features = ["std"] }
memchr = "2.7.2"
ryu = "1.0.18"
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- markdownlint-disable MD033 MD041 -->

<img src="https://kura.pro/serde_yml/images/logos/serde_yml.webp"
<img src="https://kura.pro/serde_yml/images/logos/serde_yml.svg"
alt="Serde YML logo" width="66" align="right" />

<!-- markdownlint-enable MD033 MD041 -->
Expand Down Expand Up @@ -41,17 +41,17 @@ and for inspiring this project.
```toml
[dependencies]
serde = "1.0"
serde_yml = "0.0.9"
serde_yml = "0.0.10"
```

Release notes are available under [GitHub releases][04].

## Using Serde YAML
## Using Serde YML

[API documentation is available in rustdoc form][docs.rs] but the general idea
is:

[docs.rs]: https://docs.rs/serde_yaml
[docs.rs]: https://docs.rs/serde_yml

```rust
use serde::{Serialize, Deserialize};
Expand Down
18 changes: 9 additions & 9 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,21 @@ Unless you explicitly state otherwise, any contribution intentionally submitted

#### Forked Serde YAML

- **Hard reset**: Hard reset to the latest @dtolnay [latest release](https://github.com/dtolnay/serde-yaml/commit/2009506d33767dfc88e979d6bc0d53d09f941c94) to keep traceability and retain commits history to the original [Serde YAML](https://github.com/dtolnay/serde-yaml) codebase and credits to the maintainers.
- **Renaming**: This project, has been renamed to `Serde YML` to avoid confusion with the original Serde YAML crate which is now archived and no longer maintained. While `Serde YML` started as a fork of serde-yaml, it has now evolved into a separate library with its own goals and direction in mind and does not intend to replace the original serde-yaml crate.
- **Hard reset**: Hard reset to the latest @dtolnay [latest release](https://github.com/dtolnay/serde-yaml/commit/2009506d33767dfc88e979d6bc0d53d09f941c94) to keep traceability and retain commits history to the original [Serde YAML](https://github.com/dtolnay/serde-yaml) codebase and credits to the maintainers.
- **Renaming**: This project, has been renamed to `Serde YML` to avoid confusion with the original Serde YAML crate which is now archived and no longer maintained. While `Serde YML` started as a fork of serde-yaml, it has now evolved into a separate library with its own goals and direction in mind and does not intend to replace the original serde-yaml crate.

#### CI Improvements

- **ci(serde-yaml)**: Added a missing release workflow and made minor tweaks to the README for better clarity and documentation. This update ensures smoother and more reliable release processes.
- Commit: `ci(serde-yaml): :green_heart: add missing release workflow and minor tweaks in README`
- **ci(serde-yaml)**: Added a missing release workflow and made minor tweaks to the README for better clarity and documentation. This update ensures smoother and more reliable release processes.
- Commit: `ci(serde-yaml): :green_heart: add missing release workflow and minor tweaks in README`

#### Testing Enhancements

- **test(serde-yaml)**: Enhanced test coverage by adding new unit tests for `mapping.rs`. These tests ensure the robustness and reliability of the `Mapping` struct and its associated methods.
- **test(serde-yaml)**: Enhanced test coverage by adding new unit tests for `mapping.rs`. These tests ensure the robustness and reliability of the `Mapping` struct and its associated methods.

- Commit: `test(serde-yaml): :white_check_mark: add new tests for `mapping.rs``
- Commit: `test(serde-yaml): :white_check_mark: add new tests for`mapping.rs``

- **test(serde-yaml)**: Expanded the test suite by adding comprehensive unit tests for the `ser.rs` module. The new tests cover various serialization scenarios, including scalar values, sequences, maps, nested structures, optional fields, and custom serializers.
- Commit: `test(serde-yaml): :white_check_mark: add unit tests for the `ser.rs` module`
- **test(serde-yaml)**: Expanded the test suite by adding comprehensive unit tests for the `ser.rs` module. The new tests cover various serialization scenarios, including scalar values, sequences, maps, nested structures, optional fields, and custom serializers.
- Commit: `test(serde-yaml): :white_check_mark: add unit tests for the`ser.rs`module`

**Full Changelog**: https://github.com/sebastienrousseau/serde_yml/commits/v0.0.9
**Full Changelog**: <https://github.com/sebastienrousseau/serde_yml/commits/v0.0.10>
12 changes: 12 additions & 0 deletions examples/example.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@
/// Contains the example modules for the `loader` module.
mod loader;

/// Contains the example modules for the `modules` module.
mod modules;

/// Contains the example modules for the `serializer` module.
mod serializer;

/// Contains the example modules for the `value` module.
mod value;

/// Examples for the `with` module.
mod with;

Expand All @@ -29,9 +35,15 @@ fn main() {
// Run the example module `loader`.
loader::main();

// Run the example module `modules`.
modules::main();

// Run the example module `serializer`.
serializer::main();

// Run the example module `value`.
value::main();

// Run the example module `with`.
with::main();

Expand Down
Loading

0 comments on commit 9abdc79

Please sign in to comment.