Serde YML (a fork of Serde YAML)

A Rust library for using the Serde serialization framework with data in YAML file format. 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.

Credits and Acknowledgements

This library is a continuation of the excellent work done by David Tolnay and the maintainers of the serde-yaml library.

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.

If you are currently using serde-yaml in your projects, we recommend carefully evaluating your requirements and considering the stability and maturity of the original library as well as looking at the features and improvements offered by other YAML libraries in the Rust ecosystem.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Changelog

What's Changed

Enhancements

Forked Serde YAML

• Hard reset: Hard reset to the latest @dtolnay latest release to keep traceability and retain commits history to the original 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
  • fix(serde_yml): 🐛 fix TEMPLATE and workflows by @sebastienrousseau in #2
  • fix(serde_yml): 💚 fix wrong branch name

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.

  • 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