Merge branch 'release/v0.3.3'

.editorconfig

@@ -0,0 +1,73 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[CMakeLists.txt]
+indent_size = 2
+
+[cmake/**]
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false
+
+[docs/mkdocs/docs/**.md]
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[{.clang-format,.clang-tidy}]
+indent_size = 2
+
+# Test data must not be auto-changed.
+[test/unit_test/test_data/**]
+indent_style = unset
+indent_size = unset
+tab_width = unset
+charset = unset
+end_of_line = unset
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+# Leave the endings of the file header template files untouched
+[.reuse/templates/*.jinja2]
+insert_final_newline = false
+
+# Leave the endings of the example output files untouched
+[docs/examples/*.output]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+# Unset all the settings for build directories
+[build*/**]
+indent_style = unset
+indent_size = unset
+tab_width = unset
+end_of_line = unset
+charset = unset
+trim_trailing_whitespace = unset
+insert_final_newline = unset
+
+# Unset all the settings for third party files
+[thirdparty/**]
+indent_style = unset
+indent_size = unset
+tab_width = unset
+end_of_line = unset
+charset = unset
+trim_trailing_whitespace = unset
+insert_final_newline = unset

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -10,7 +10,7 @@ body:
         Make sure you give it a short and specific **title** so that the report is
         searchable and uniquely identifiable for developers.
         Note that this form is for bug reports only. Please [open a discussion](https://github.com/fktn-k/fkYAML/discussions/new)
-        for questions, feature requests, or support requests.  
+        for questions, feature requests, or support requests.
   - type: textarea
     id: summary
     attributes:
@@ -26,7 +26,7 @@ body:
     attributes:
       label: Reproduction steps
       description: >
-        How do you trigger the bug?  
+        How do you trigger the bug?
         Let the developers who see this report reproduce your situation as you do.
         Please describe your reproduction steps as specifically as possible.
     validations:
@@ -37,7 +37,7 @@ body:
       label: Expected vs. actual results
       description: >
         Please describe what you expected to happen after the steps above and
-        what actually happened. 
+        what actually happened.
     validations:
       required: true
   - type: textarea
@@ -73,9 +73,9 @@ body:
     attributes:
       label: Library version
       description: >
-        Which version of the library did you use?  
-        If it is a released version, please enter the version number.  
-        Otherwise, please enter the commit hash.  
+        Which version of the library did you use?
+        If it is a released version, please enter the version number.
+        Otherwise, please enter the commit hash.
         If you got the library from another source as the GitHub repository
         (e.g., via a package manager), please also state the source as well.
     validations:

.github/ISSUE_TEMPLATE/config.yml

@@ -2,4 +2,4 @@ blank_issues_enabled: false
 contact_links:
   - name: Ask a question
     url: https://github.com/fktn-k/fkYAML/discussions
-    about: Ask questions and discuss with other community members.
+    about: Ask questions and discuss with other community members.

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,4 +15,4 @@ Read the [CONTRIBUTING.md](https://github.com/fktn-k/fkYAML/blob/develop/CONTRIB
 
 - The C++11 support varies between different **compilers** and versions. Please note the [list of supported compilers](https://github.com/fktn-k/fkYAML/blob/develop/README.md#supported-compilers). Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with `#ifdef`s or other means.
 - Please refrain from proposing changes that would **break [YAML](https://yaml.org/) specifications**. If you propose a conformant extension of YAML to be supported by the library, please motivate this extension.
-- Please do not open pull requests that address **multiple issues**.
+- Please do not open pull requests that address **multiple issues**.

.github/workflows/amalgamation_check.yml

@@ -28,7 +28,7 @@ jobs:
     timeout-minutes: 10
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Check if the amalgamated header file is up-to-date.
       run: make check-amalgamate

.github/workflows/clang_format_check.yml

@@ -33,7 +33,7 @@ jobs:
           - test/unit_test
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 

.github/workflows/codeql.yml

@@ -36,13 +36,13 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         submodules: recursive
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -56,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
     # If this step fails, then you should remove it and run the build manually (see below)
     # - name: Autobuild
-    #   uses: github/codeql-action/autobuild@v2
+    #   uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -69,6 +69,6 @@ jobs:
         cmake --build ${{github.workspace}}/build --config Release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/coverage.yml

@@ -26,9 +26,11 @@ jobs:
   coverage:
     timeout-minutes: 10
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 
@@ -39,11 +41,46 @@ jobs:
         lcov -v
 
     - name: Generate coverage
-      run: make lcov-coverage
+      run: make html-coverage
 
     - name: Upload coverage to Coveralls
       uses: coverallsapp/github-action@v2
       with:
         github-token: ${{secrets.GITHUB_TOKEN}}
         file: ${{github.workspace}}/build_coverage/coverage/fkYAML.info
-        format: lcov
+        format: lcov
+
+    - name: Decide the artifact name
+      id: create_zip
+      if: github.event_name == 'pull_request'
+      env:
+        PR_NUMBER: ${{github.event.number}}
+      run: |
+        echo "artifact name: fkYAML_coverage.pr${{env.PR_NUMBER}}"
+        echo "artifact_name=fkYAML_coverage.pr${{env.PR_NUMBER}}" >> $GITHUB_OUTPUT
+
+    - name: Upload coverage as an artifact
+      id: upload_artifact_step
+      if: steps.create_zip.conclusion == 'success'
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{steps.create_zip.outputs.artifact_name}}
+        path: |
+          ${{github.workspace}}/build_coverage/coverage/*
+          ${{github.workspace}}/build_coverage/html/**
+        overwrite: true
+
+    - name: Notify the artifact URL
+      if: steps.upload_artifact_step.conclusion == 'success'
+      uses: thollander/actions-comment-pull-request@v2
+      with:
+        message: |
+          ## :octocat: Upload Coverage Event Notification
+          Coverage data has been uploaded for the commit [${{github.event.pull_request.head.sha}}](https://github.com/${{github.repository}}/commit/${{github.event.pull_request.head.sha}}).
+          You can download the artifact which contains the same file uploaded to the Coveralls and its HTML version.
+
+          | Name | ${{steps.create_zip.outputs.artifact_name}}.zip      |
+          |:-----|:-----------------------------------------------------|
+          | ID   | ${{steps.upload_artifact_step.outputs.artifact-id}}  |
+          | URL  | ${{steps.upload_artifact_step.outputs.artifact-url}} |
+        comment_tag: notification

.github/workflows/macos.yml

@@ -39,7 +39,7 @@ jobs:
         single_header: ["ON", "OFF"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 
@@ -64,7 +64,7 @@ jobs:
       DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 
@@ -89,7 +89,7 @@ jobs:
       DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 
@@ -114,7 +114,7 @@ jobs:
       DEVELOPER_DIR: /Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 

.github/workflows/publish_docs.yml

@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -40,10 +40,10 @@ jobs:
         run: make -C docs/mkdocs build
 
       - name: Setup Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
 
       - name: Upload API documents
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ${{github.workspace}}/docs/mkdocs/site
 
@@ -58,4 +58,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

.github/workflows/release_package.yml

@@ -2,7 +2,7 @@ name: ReleasePackage
 
 on:
   push:
-    branches: 
+    branches:
       - main
   workflow_dispatch:
 
@@ -17,19 +17,19 @@ jobs:
         include:
           - os: ubuntu-latest
             artifact_name: fkYAML.tgz
-            single_header: "ON"
+            single_header: "OFF"
           - os: ubuntu-latest
             artifact_name: fkYAML_single_header.tgz
-            single_header: "OFF"
+            single_header: "ON"
           - os: windows-latest
             artifact_name: fkYAML.zip
-            single_header: "ON"
+            single_header: "OFF"
           - os: windows-latest
             artifact_name: fkYAML_single_header.zip
-            single_header: "OFF"
+            single_header: "ON"
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 
@@ -54,7 +54,7 @@ jobs:
         ls
 
     - name: Upload Artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: ${{matrix.artifact_name}}
         path: ${{matrix.artifact_name}}