Skip to content

Releases

fkYAML version 0.3.7

Release Packages

Summary

This release includes refactoring of YAML escaping and improvement of the way of managing anchor/alias nodes.
Furthermore, several bugs found in the deserializer are resolved.

For contributors, the results of executing clang-format and amalgamation in the GitHub Actions workflows are now automatically applied to the source files.
You can, of course, still run those tools locally but that's not required from this release on.
For more details, see the CONTRIBUTING.md file.

What's Changed

⚡ Improvements

  • Separate YAML escaping/unescaping functionalities by @fktn-k in #337
  • Improve anchor alias node management by @fktn-k in #340

🐛 Bug Fixes

  • Fix false error on anchor names containing colons (:) by @fktn-k in #335
  • Escape backslash(\) + 0x09 to a horizontal tab (\t) by @fktn-k in #336
  • Fixed error on node properties for child block sequences by @fktn-k in #338
  • Fix the C6262 warning on Windows by @fktn-k in #339

🤖 CI

  • Run and apply the result of clang-format & amalagamation in GA workflows by @fktn-k in #341

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.6...v0.3.7

fkYAML version 0.3.6

Release Packages

Summary

This release includes enhancements to the deserializer, improving both performance and readability.
Furthermore, it resolves several issues identified in the deserializer and improves conformance to the YAML specification.

What's Changed

⚡ Improvements

🐛 Bug Fixes

  • Fixed parser crashes on a sequence right after the directives end marker by @fktn-k in #327
  • Allow backslashes in plain/single-quoted scalars by @fktn-k in #329
  • Fixed parse error on root block sequence with child block sequences by @fktn-k in #330
  • Fix parse error on block sequences with child flow style container nodes by @fktn-k in #332
  • Fixed parse error on block sequences with child block mappings split by a newline code by @fktn-k in #333

🧑‍🤝‍🧑 Community

  • Fixed no such file/directory error when running Bash scripts on Windows by @fktn-k in #328

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.5...v0.3.6

fkYAML version 0.3.5

Release Packages

Summary

This release adds the new support for serialization of YAML container key nodes either with or without tags and/or anchors.
In addition, Win32 builds are now tested during the GitHub Actions workflows. Moreover, the performance and efficiency of Unicode handlings have been improved by refactoring the deserialization feature.

For contributors, fkYAML now depends on the Clang-Format Python distribution as the source code formatter and provides Bash/Batch scripts for running the Clang-Format and amalgamation.
For more information, see the latest CONTRIBUTING.md file.

What's Changed

✨ New Features

⚡ Improvements

🐛 Bug Fixes

  • Fix parse error on the first node which isn't a block mapping by @fktn-k in #322
  • Force LF newline codes in the amalgamated file by @fktn-k in #324

🤖 CI

  • Add workflows items to test Win32 builds by @fktn-k in #323

🧑‍🤝‍🧑 Community

  • Use Clang-Format python distribution by @fktn-k in #316
  • Set the unit test app as the Visual Studio startup project by @fktn-k in #321
  • Add Bash & Batch scripts to run clang-format & amalgamation by @fktn-k in #325

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.4...v0.3.5

fkYAML version 0.3.4

Release Packages

Summary

This release adds the new support for YAML tags in both the deserialization and serialization features while improving the performance and efficiency of the deserialization feature.
In addition, std::basic_string_view types, such as std::string_view, are now explicitly supported, and implementations of conversion from string scalar nodes and test cases for the functions that take those types as arguments.
For CI processes, workflows using the macOS 14 GitHub Actions runner image have been added, and platform support for fkYAML has been extended.

What's Changed

✨ New Features

  • #181 support tag for scalars by fktn-k in #305
  • support tags for container nodes with some cleanup in test suite by fktn-k in #309
  • Add workflow jobs with the macOS14 runner image by fktn-k in #310
  • #294 Support std::basic_string_view by fktn-k in #313
  • #181 Serialize container tags by fktn-k in #314

⚡ Improvements

🤖 CI

  • Fix Valgrind error in the test suite by fktn-k in #307
  • Organized the contents of the test suite by fktn-k in #311

📝 Documentation

  • updated dependencies for mkdocs to the latest versions by fktn-k in #312

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.3...v0.3.4

fkYAML version 0.3.3

Release Packages

Summary

This release adds a new basic_node API, at(), which validates before either (1) that the specified key exists in the mapping or (2) that the specified index is less than the current size of the sequence before accessing the target node.
Several bugs bugs in the deserialization feature have also been fixed.
In addition, refactoring of the deserializer has improved the handling of input characters.

What's Changed

✨ New Features

  • #298 Add at() API to the basic_node class by fktn-k in #299

⚡ Improvements

  • Further improvements of input handlings by fktn-k in #301
  • Fixed warnings and made future warnings as errors by fktn-k in #300
  • Improve handling UTF encoded inputs by fktn-k in #296
  • modied the way of formatting error messages for exception objects by fktn-k in #291

🐛 Bug Fixes

  • #302 Fixed parse error on alias mapping keys #303 fktn-k
  • #292 Better handling for flow indicators in permitted scalar contexts by stephenwhittle in #293
  • #288 Fixed incorrect parse results from mapping entries split across newlines by fktn-k in #289 (reported by stephenwhittle)

🤖 CI

  • Resolve warnings against using Node.js 16 by fktn-k in #290

🧑‍🤝‍🧑 Community

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.2...v0.3.3

fkYAML version 0.3.2

Release Packages

Summary

This release contains the char8_t support for deserialization and bug fixes related to the deserialization feature.
Furthermore, the list of the supported compilers are expanded since the GitHub Actions runner image macOS-13 has been officially released.

What's Changed

✨ New Features

  • #237 Support char8_t in deserialization #269 (fktn-k)

⚡ Improvements

🐛 Bug Fixes

  • #281 Fixed the parser crash due to comments right after a sequence block key #284 (fktn-k)
  • #282 Don't traverse up to the parent node immediately after parsing a flow-mapping value #283 (stephenwhittle)
  • #277 Fixed incorrect parse result from plain scalars starting with special values #278 (fktn-k)
  • #275 Fixed parse error on plain scalars containing flow indicators #276 (fktn-k)
  • #272 Fix parse error on a block sequence containing a comment within #273 (fktn-k)

🤖 CI

  • Add workflow jobs with the macos-13 runner image #274 (fktn-k)

📝 Documentation

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.1...v0.3.2

fkYAML version 0.3.1

Release Packages

Summary

From this release on, fkYAML provides the amalgamated version to improve portability as a header-only library.
Also, this release contains bug-fixes in the deserialization process.
Furthermore, the documentation now uses outputs from the sources in docs/examples directory to keep the examples in the documentation up to date with the latest library sources.

What's Changed

✨ New Features

⚡ Improvements

  • #256 Added specialization of from_node() for std::map with compatible key/value types #260 (fktn-k)

🐛 Bug Fixes

  • Avoid using unintended C++14 features #266 (fktn-k) reported by @burgreen
  • Allow a dash(-) at the first character of a plain scalar #254 (fktn-k)
  • Allow double quotation marks in plain scalars #253 (fktn-k)
  • #242 Fix error in parsing string consisting only of numbers and multiple dots #251 (fktn-k)

🤖 CI

  • Added paths filter to regulate workflow executions #263 (fktn-k)

📝 Documentation

  • fixed typos which needs to be target_link_libraries() in tutorials #267 (fktn-k) reported by @burgreen
  • #229 Fix the documentation build errors #265 (fktn-k)
  • #229 build example code and use output #264 (fktn-k)

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.3.0...v0.3.1

fkYAML version 0.3.0

Release Packages

Summary

This release contains some breaking changes in the basic_node's mapping node type so that fkYAML supports non-string-scalar nodes, such as mappings or integer scalars, as mapping keys.
Furthermore, from this release on, GCC-7 and GCC-8 are in the list of supported compilers and used for testing on GitHub Actions.

What's Changed

💥 Breaking Changes

  • #240 Support explicit block mappings & non-scalar nodes as mapping keys #245 (fktn-k)
  • #240 Support non-string scalar nodes as mapping keys #244 (fktn-k)
  • Feature/238 apply correct noexcept #241 (fktn-k)

⚡ Improvements

  • #240 Support non-string-scalar node keys in basic_node ctor with std::initializer_list #247 (fktn-k)
  • #240 implement node comparison #243 (fktn-k)

🐛 Bug Fixes

  • Fixed missing callings of fclose() in the unit tests #246 (fktn-k)

🤖 CI

  • Add GCC compiler versions tested in GA workflows #248 (fktn-k)

📝 Documentation

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.2.3...v0.3.0

fkYAML version 0.2.3

Release Packages

Summary

This release contains support for the deserialization of YAML block style scalars and the user-defined string literals for YAML node objects.
A bug in parsing UTF-16 encoded inputs has also been fixed in this release.
Furthermore, from this release on, natvis debugger visualization file is/will be contained when fkYAML is built with the MSVC environments for better debugging experience.

What's Changed

⚡ Improvements

  • Feature/232 user defined literal for deserialization #235 (fktn-k)
  • #159 Support block scalar styles #228 (fktn-k)
  • Feature/226 add natvis file #227 (fktn-k)

🐛 Bug Fixes

  • fixed parsing UTF-16 encoded inputs which do not end with a surrogate… #234 (fktn-k)

📝 Documentation

  • Improved contribution guide #231 (fktn-k)
  • Removed dependency on the cmake-format tool #230 (fktn-k)
  • Fixed wrong URLs in the releases page of the documentation #225 (fktn-k)

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.2.2...v0.2.3

fkYAML version 0.2.2

Release Packages

Summary

This release supports the UTF-8, UTF-16BE/LE, and UTF-32BE/LE encodings including BOMs in parsing YAML documents, and improved the contents of error messages by adding runtime information when exceptions are thrown.
Furthermore, bugs in the deserialization/serialization features have also been fixed.

Warning

The fkYAML library is an alpha quality software, at most.
It would take a while until this library gets stabled version, since implementation and maintenance has been/will be done by a single developer.
If you find a bug or wanted features, please open a discussion/issue to let me know.
Any kind of contribution is very much welcomed.

What's Changed

⚡ Improvements

  • #209 Support auto-detection of Unicode encoding types including BOMs #223 (fktn-k)
  • #214 Emit more descriptive errors #222 (fktn-k)
  • #209 support UTF-16 / UTF-32 for deserialization input characters #221 (fktn-k)

🐛 Bug Fixes

  • #218 Fixed lacking quotes & escapes during serializtion #220 (fktn-k)
  • #217 Fix parse errors on strings containing single quotes #219 (fktn-k)

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.2.1...v0.2.2

fkYAML version 0.2.1

Release Packages

Summary

This release supports the UTF-8 encoding (both escaped/unescaped) in parsing YAML documents.
Furthermore, bugs in the deserialization feature have also been fixed.

Warning

The fkYAML library is an alpha quality software, at most.
It would take a while until this library gets stabled version, since implementation and maintenance has been/will be done by a single developer.
If you find a bug or wanted features, please open a discussion/issue to let me know.
Any kind of contribution is very much welcomed.

What's Changed

⚡ Improvements

  • #209 support escaped unicode #215 (fktn-k)
  • #209 Support unescaped UTF-8 input characters in deserialization #210 (fktn-k)
  • #207 Support markers for the end of directives/documents #208 (fktn-k)
  • #190 Support specialization of deserialization for a vector of user-defined type objects #203 (fktn-k)
  • #195 Implement insertion/extraction operators for basic_node template class #201 (fktn-k)

🐛 Bug Fixes

  • #211 Fix indentation handling #213 (fktn-k)
  • #211 fixed bug in parsing single quoted strings #212 (fktn-k)
  • #205 Detect duplicate keys as an error #206 (fktn-k)
  • #200 Allow a space in unquoted strings #202 (fktn-k)

📝 Documentation

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.2.0...v0.2.1

fkYAML version 0.2.0

Release Packages

Summary

This release contains a breaking change in the default type for YAML mapping node: it will no longer preserve insertion order of internal key/value pairs by default.
To preserve the insertion order as it used to, use fkyaml::ordered_map as basic_node's mapping node type.
Furthermore, factory methods for scalar values of basic_node type have been removed and unified into the basic_node constructors.
Along with the above changes, internal operations in the fkYAML have also been improved regarding conversions between YAML nodes and values of native data types.

Warning

The fkYAML library is an alpha quality software, at most.
It would take a while until this library gets stabled version, since implementation and maintenance has been/will be done by a single developer.
If you find a bug or wanted features, please open a discussion/issue to let me know.
Any kind of contribution is very much welcomed.

What's Changed

💥 Breaking Changes

  • #180 clean up public apis #183 (fktn-k)
  • #167 Use std::map as the default mapping node type #174 (fktn-k)

⚡ Improvements

  • #187 support compatible strings as an argument in basic_node ctors #188 (fktn-k)
  • #180 Generalize getter APIs for node value references #184 (fktn-k)
  • #105 Support std::initializer_list in basic_node constructors #173 (fktn-k)

🐛 Bug Fixes

  • #185 fixed missing calls for fclose() in input adapter tests #186 (fktn-k)
  • #175 support detecting indentation in deserialization #176 (fktn-k)

🤖 CI

  • Updated header template and target file for version up script #197 (fktn-k)
  • #177 Add test for input adapters only #178 (fktn-k)

📝 Documentation

  • #179 Added integration with Google Analytics 4 #196 (fktn-k)
  • #179 Updated pages in the Home section in the documentation #194 (fktn-k)
  • #179 Migrate the gh-page content with MkDocs #193 (fktn-k)
  • #179 Created tutorial pages #192 (fktn-k)
  • #179 Migrate API docs with MkDocs #189 (fktn-k)
  • #179 introduce mkdocs for documentation #182 (fktn-k)

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.1.3...v0.2.0

fkYAML version 0.1.3

Release Packages

Summary

This release contains improvements of the fkYAML library's internal operations with some reorganization of CMake scripts.
In addition, the analysis result from Codacy has become shown at the top of the README.md file.

CAVEAT

The fkYAML library is an alpha quality software, at most.
It would take a while until this library gets stabled version, since implementation and maintenance has been/will be done by a single developer.
If you find a bug or wanted features, please open a discussion/issue to let me know.
Any kind of contribution is very much welcomed.

What's Changed

⚡ Improvements

🔨 Tool/Service Integrations

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.1.2...v0.1.3

fkYAML version 0.1.2

Summary

This release contains improvements regarding internal implementation of the fkYAML library.
Furthermore, new unit test cases have been added and the coverage result (C1) is now 100%.

CAVEAT

The fkYAML library is an alpha quality software, at most.
It would take a while until this library gets stabled version, since implementation and maintenance has been/will be done by a single developer.
If you find a bug or wanted features, please open a discussion/issue to let me know.
Any kind of contribution is very much welcomed.

What's Changed

⚡ Improvements

🐛 Bug Fixes

🤖 CI

📝 Documentation

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.1.1...v0.1.2

fkYAML version 0.1.1

Summary

This release contains a hotfix for the test suite to check CMake integration with FetchContent module which uses the old fkYAML APIs.
All changes are backward-compatible. See release notes of version 0.1.0 for more information on other features.

CAVEAT

The fkYAML library is a alpha quality software. Implementation and maintenance has been/will be done by a single developer. If you find a bug or wanted features, please open a discussion/issue to let us know. Any kind of contribution is very much welcomed.

What's Changed

🐛 Bug Fixes

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.1.0...v0.1.1

fkYAML version 0.1.0

Summary

This release contains a huge change in public APIs, including naming conventions and migration of serialization/deserialization features to fkyaml::basic_node class APIs.
Furthermore, internal implementation of the fkYAML library has been intentionally moved to include/fkYAML/detail's subdirectories so that we can provide as much backward compatibility as possible for the future releases.

CAVEAT

The fkYAML library is a alpha quality software.
Implementation and maintenance has been/will be done by a single developer.
If you find a bug or wanted features, please open a discussion/issue to let us know. Any kind of contribution is very much welcomed.

What's Changed

⚡ Improvements

📝 Documentation

🤖 CI

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.0.0...v0.1.0

fkYAML version 0.0.1

Summary

This release improves internal operations in the fkYAML library and adds unit tests for the existing classes.
Furthermore, several tool/service integrations has been incorporated for better maintainability.

What's Changed

⚡ Improvements

🔨 Tool/Service Integrations

🤖 CI

📝 Documentation

🧑‍🤝‍🧑 Community

Full Changelog: https://github.com/fktn-k/fkYAML/compare/v0.0.0...v0.0.1

fkYAML v0.0.0

This release provides basic features of the fkYAML library.
Major known issues and limitaions are as follows:

  • %TAG directives are not supported. (Will surely be implemented.)
  • YAML key must be a string literal. (YAML specification of any version does not restrict YAML keys as such.)
  • Backward compatibilities for YAML 1.1 or older have not yet been implemented.

The other issues and limitations will also be fixed in later versions.
Wait for such a version, or create a PR to fix one.