Merge branch 'release/v0.3.4'

Author: fktn-k

.github/workflows/macos.yml

@@ -26,9 +26,6 @@ concurrency:
   group: ${{github.workflow}}-${{github.ref || github.run_id}}
   cancel-in-progress: true
 
-env:
-  JOBS: 3
-
 jobs:
   macos-latest:
     timeout-minutes: 10
@@ -37,6 +34,8 @@ jobs:
       matrix:
         build_type: [ Debug, Release ]
         single_header: ["ON", "OFF"]
+    env:
+      JOBS: 2
 
     steps:
     - uses: actions/checkout@v4
@@ -62,6 +61,7 @@ jobs:
         build_type: [ Debug, Release ]
     env:
       DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
+      JOBS: 2
 
     steps:
     - uses: actions/checkout@v4
@@ -87,6 +87,7 @@ jobs:
         build_type: [ Debug, Release ]
     env:
       DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
+      JOBS: 2
 
     steps:
     - uses: actions/checkout@v4
@@ -112,6 +113,33 @@ jobs:
         build_type: [ Debug, Release ]
     env:
       DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
+      JOBS: 3
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{matrix.build_type}} -DFK_YAML_BUILD_TEST=ON
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{matrix.build_type}} -j ${{env.JOBS}}
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      run: ctest -C ${{matrix.build_type}} --output-on-failure -j ${{env.JOBS}}
+
+  xcode_for_macos14:
+    timeout-minutes: 10
+    runs-on: macos-14
+    strategy:
+      matrix:
+        xcode: [ '14.3.1', '15.0.1', '15.1', '15.2', '15.3' ]
+        build_type: [ Debug, Release ]
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
+      JOBS: 2
 
     steps:
     - uses: actions/checkout@v4

.reuse/templates/fkYAML.commented.jinja2

@@ -1,6 +1,6 @@
 ///  _______   __ __   __  _____   __  __  __
 /// |   __| |_/  |  \_/  |/  _  \ /  \/  \|  |     fkYAML: A C++ header-only YAML library
-/// |   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.3.3
+/// |   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.3.4
 /// |__|  |_| \__|  |_|  |_|   |_|___||___|______| https://github.com/fktn-k/fkYAML
 ///
 {% for copyright_line in copyright_lines %}

.reuse/templates/fkYAML_support.jinja2

@@ -1,6 +1,6 @@
  _______   __ __   __  _____   __  __  __
 |   __| |_/  |  \_/  |/  _  \ /  \/  \|  |     fkYAML: A C++ header-only YAML library (supporting code)
-|   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.3.3
+|   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.3.4
 |__|  |_| \__|  |_|  |_|   |_|___||___|______| https://github.com/fktn-k/fkYAML
 
 {% for copyright_line in copyright_lines %}

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v0.3.4](https://github.com/fktn-k/fkYAML/releases/tag/v0.3.4) (2024-04-20)
+
+[Full Changelog](https://github.com/fktn-k/fkYAML/compare/v0.3.3...v0.3.4)
+
+- Fix Valgrind error in the test suite [\#307](https://github.com/fktn-k/fkYAML/pull/307) ([fktn-k](https://github.com/fktn-k))
+
+- \#181 Serialize container tags [\#314](https://github.com/fktn-k/fkYAML/pull/314) ([fktn-k](https://github.com/fktn-k))
+- \#294 Support std::basic\_string\_view [\#313](https://github.com/fktn-k/fkYAML/pull/313) ([fktn-k](https://github.com/fktn-k))
+- updated dependencies for mkdocs to the latest versions [\#312](https://github.com/fktn-k/fkYAML/pull/312) ([fktn-k](https://github.com/fktn-k))
+- Organized the contents of the test suite [\#311](https://github.com/fktn-k/fkYAML/pull/311) ([fktn-k](https://github.com/fktn-k))
+- Add workflow jobs with the macOS14 runner image [\#310](https://github.com/fktn-k/fkYAML/pull/310) ([fktn-k](https://github.com/fktn-k))
+- support tags for container nodes with some cleanup in test suite [\#309](https://github.com/fktn-k/fkYAML/pull/309) ([fktn-k](https://github.com/fktn-k))
+- Defer scalar conversions [\#308](https://github.com/fktn-k/fkYAML/pull/308) ([fktn-k](https://github.com/fktn-k))
+- Scan inputs using iterators [\#306](https://github.com/fktn-k/fkYAML/pull/306) ([fktn-k](https://github.com/fktn-k))
+- \#181 support tag for scalars [\#305](https://github.com/fktn-k/fkYAML/pull/305) ([fktn-k](https://github.com/fktn-k))
+
 ## [v0.3.3](https://github.com/fktn-k/fkYAML/releases/tag/v0.3.3) (2024-03-31)
 
 [Full Changelog](https://github.com/fktn-k/fkYAML/compare/v0.3.2...v0.3.3)

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.8)
 
 project(
   fkYAML
-  VERSION 0.3.3
+  VERSION 0.3.4
   LANGUAGES CXX)
 
 #############################################################

Makefile

@@ -1,4 +1,4 @@
-.PHONY: update-version-macros CHANGELOG.md update-version fkYAML.natvis
+.PHONY: update-version-macros CHANGELOG.md update-version examples fkYAML.natvis
 
 #################
 #   variables   #
@@ -14,7 +14,7 @@ TEST_SRCS = $(shell find test -type f \( -name '*.hpp' -o -name '*.cpp' \) | sor
 # target version definition
 TARGET_MAJOR_VERSION := 0
 TARGET_MINOR_VERSION := 3
-TARGET_PATCH_VERSION := 3
+TARGET_PATCH_VERSION := 4
 TARGET_VERSION_FULL := $(TARGET_MAJOR_VERSION).$(TARGET_MINOR_VERSION).$(TARGET_PATCH_VERSION)
 VERSION_MACRO_FILE := include/fkYAML/detail/macros/version_macros.hpp
 
@@ -96,6 +96,20 @@ update-params-for-natvis:
 fkYAML.natvis: update-params-for-natvis
 	@$(MAKE) -C ./tool/natvis_generator generate
 
+#####################
+#   Documentation   #
+#####################
+
+examples:
+	cmake -B build_examples -S . -DCMAKE_BUILD_TYPE=Debug -DFK_YAML_BUILD_EXAMPLES=ON
+	cmake --build build_examples --config Debug
+
+build-docs: examples
+	@$(MAKE) -C ./docs/mkdocs build
+
+serve-docs: examples
+	@$(MAKE) -C serve
+
 ###############
 #   Version   #
 ###############
@@ -169,5 +183,6 @@ clean:
 		build_clang_sanitizers \
 		build_clang_tidy \
 		build_coverage \
+		build_examples \
 		build_iwyu \
 		build_valgrind

README.md

@@ -30,7 +30,7 @@ There are a lot of YAML libraries out there, and each may have its reason to exi
 fkYAML has been developed with these design goals:  
 
 ### :briefcase: **Portable**  
-The whole code depends only on C++ standards, and is carefully designed to work on many platforms so that fkYAML can be imported into existing C++ projects written in C++11 or later.  
+The whole code depends only on C++ standards, and is carefully designed to work on many platforms so that fkYAML can be imported into existing C++ projects written in C++11 or better.  
 No external dependencies, no sub-project, or no additional compiler flags are required.  
 Although fkYAML is a library with multiple header files by default, you can use the single-header version located in the [single_include](https://github.com/fktn-k/tree/develop/single_include) directory.  
 Furthermore, the project supports [CMake](https://cmake.org/) and provides [the documentation exclusively for CMake integration](https://fktn-k.github.io/fkYAML/tutorials/cmake_integration).  
@@ -98,8 +98,12 @@ Currently, the following compilers are known to work and used in GitHub Actions
 | AppleClang 14.0.0.14000029 | [macOS 12](https://github.com/actions/runner-images/blob/main/images/macos/macos-12-Readme.md)                 |
 | AppleClang 14.0.0.14000029 | [macOS 13](https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md)                 |
 | AppleClang 14.0.3.14030022 | [macOS 13](https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md)                 |
+| AppleClang 14.0.3.14030022 | [macOS 14](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md)                 |
 | AppleClang 15.0.0.15000040 | [macOS 13](https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md)                 |
+| AppleClang 15.0.0.15000040 | [macOS 14](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md)                 |
 | AppleClang 15.0.0.15000100 | [macOS 13](https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md)                 |
+| AppleClang 15.0.0.15000100 | [macOS 14](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md)                 |
+| AppleClang 15.0.0.15000309 | [macOS 14](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md)                 |
 | Clang 3.5.2                | [Ubuntu 22.04](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md)          |
 | Clang 3.6.2                | [Ubuntu 22.04](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md)          |
 | Clang 3.7.1                | [Ubuntu 22.04](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md)          |

docs/examples/ex_basic_node_add_tag_name.cpp

@@ -0,0 +1,18 @@
+#include <iostream>
+#include <fkYAML/node.hpp>
+
+int main()
+{
+    // create a YAML node.
+    fkyaml::node n = 123;
+
+    // set a tag name to the node.
+    n.add_tag_name("!!int");
+    std::cout << n.get_tag_name() << std::endl;
+
+    // overwrite it with a new one.
+    n.add_tag_name("!!foo");
+    std::cout << n.get_tag_name() << std::endl;
+
+    return 0;
+}

docs/examples/ex_basic_node_add_tag_name.output

@@ -0,0 +1,2 @@
+!!int
+!!foo

docs/examples/ex_basic_node_get_anchor_name.cpp

@@ -16,7 +16,7 @@ int main()
         std::cout << e.what() << std::endl;
     }
 
-    // add an anchor name to the node.
+    // set an anchor name to the node.
     n.add_anchor_name("anchor");
     std::cout << n.get_anchor_name() << std::endl;