updates for release 2.1.0 (#309)

The Github Action versions of checkout and setup-ruby have been updated. Some build instructions have been updated to use cmake build mode for increase portability. Google Test and Benchmark have been updated to recent commits. Doxygen generation has been fixed to account for the STUMPLESS_PUBLIC_FUNCTION function attribute.
goatshriek · Nov 13, 2022 · 9f6a776 · 9f6a776
1 parent 57775b3
commit 9f6a776
Show file tree

Hide file tree

Showing 20 changed files with 118 additions and 106 deletions.
diff --git a/.github/workflows/analysis.yml b/.github/workflows/analysis.yml
@@ -12,7 +12,7 @@ jobs:
     name: "custom analysis"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Check Headers
         run: |
           tools/check_headers/check_headers.rb "include/**/*.h*" "include/**/**/*.h"
@@ -36,7 +36,7 @@ jobs:
         language: [ 'cpp' ]
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
       with:
@@ -49,7 +49,7 @@ jobs:
     name: "sonarcloud analysis"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Configure

diff --git a/.github/workflows/cygwin.yml b/.github/workflows/cygwin.yml
@@ -14,7 +14,7 @@ jobs:
     name: "cygwin, release"
     runs-on: "windows-2019"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Cache Google Test and Benchmark
         uses: actions/cache@v2
         id: cache-google-libs

diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -18,7 +18,7 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install doxygen libsystemd-dev valgrind
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCOVERAGE=ON -DCMAKE_BUILD_TYPE=Debug .
@@ -64,7 +64,7 @@ jobs:
     name: "linux, release"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr .
@@ -106,7 +106,7 @@ jobs:
     name: "linux, release, static library"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_SHARED_LIBS=OFF .
@@ -148,7 +148,7 @@ jobs:
     name: "linux, all features disabled, debug"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCOVERAGE=ON -DCMAKE_BUILD_TYPE=Debug -DENABLE_JOURNALD_TARGETS=OFF -DENABLE_NETWORK_TARGETS=OFF -DENABLE_SOCKET_TARGETS=OFF -DENABLE_WINDOWS_EVENT_LOG_TARGETS=OFF -DENABLE_THREAD_SAFETY=OFF .
@@ -173,7 +173,7 @@ jobs:
     name: "linux, all features disabled, release"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_JOURNALD_TARGETS=OFF -DENABLE_NETWORK_TARGETS=OFF -DENABLE_SOCKET_TARGETS=OFF -DENABLE_WINDOWS_EVENT_LOG_TARGETS=OFF -DENABLE_THREAD_SAFETY=OFF .
@@ -194,8 +194,8 @@ jobs:
     name: "linux, with c++, debug"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/[email protected].2
+      - uses: actions/checkout@v3
+      - uses: actions/[email protected].3
       - name: Install Prereqs
         run: |
           sudo apt-get update
@@ -227,8 +227,8 @@ jobs:
     name: "linux, with c++, release"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/[email protected].2
+      - uses: actions/checkout@v3
+      - uses: actions/[email protected].3
       - name: Install Gems
         run: |
           gem install bundler

diff --git a/.github/workflows/locale.yml b/.github/workflows/locale.yml
@@ -16,7 +16,7 @@ jobs:
     env:
       LANG: "de_DE.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -36,7 +36,7 @@ jobs:
     env:
       LANG: "cz_ES.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -56,7 +56,7 @@ jobs:
     env:
       LANG: "es_ES.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -76,7 +76,7 @@ jobs:
     env:
       LANG: "fr_FR.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -96,7 +96,7 @@ jobs:
     env:
       LANG: "it_IT.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -116,7 +116,7 @@ jobs:
     env:
       LANG: "sk_SK.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -136,7 +136,7 @@ jobs:
     env:
       LANG: "pl_PL.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -156,7 +156,7 @@ jobs:
     env:
       LANG: "sv_SE.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -176,7 +176,7 @@ jobs:
     env:
       LANG: "bg_BG.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -196,7 +196,7 @@ jobs:
     env:
       LANG: "el_GR.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -216,7 +216,7 @@ jobs:
     env:
       LANG: "pt_BR.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -236,7 +236,7 @@ jobs:
     env:
       LANG: "zh_CN.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -256,7 +256,7 @@ jobs:
     env:
       LANG: "hi_IN.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .
@@ -276,7 +276,7 @@ jobs:
     env:
       LANG: "bn_IN.UTF-8"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake .

diff --git a/.github/workflows/mac.yml b/.github/workflows/mac.yml
@@ -14,7 +14,7 @@ jobs:
     name: "debug"
     runs-on: "macos-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCOVERAGE=ON -DCMAKE_BUILD_TYPE=Debug .
@@ -53,7 +53,7 @@ jobs:
     name: "release"
     runs-on: "macos-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCMAKE_BUILD_TYPE=Release .
@@ -92,7 +92,7 @@ jobs:
     name: "release, static library"
     runs-on: "macos-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF .
@@ -133,7 +133,7 @@ jobs:
     name: "all features disabled"
     runs-on: "macos-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -DCOVERAGE=ON -DENABLE_JOURNALD_TARGETS=OFF -DENABLE_NETWORK_TARGETS=OFF -DENABLE_SOCKET_TARGETS=OFF -DENABLE_WINDOWS_EVENT_LOG_TARGETS=OFF -DENABLE_THREAD_SAFETY=OFF .
@@ -158,8 +158,8 @@ jobs:
     name: "with c++"
     runs-on: "macos-latest"
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/[email protected].2
+      - uses: actions/checkout@v3
+      - uses: actions/[email protected].3
       - name: Install Gems
         run: |
           gem install bundler

diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -14,7 +14,7 @@ jobs:
     name: "windows, debug"
     runs-on: "windows-2019"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -G "Visual Studio 16 2019" -DCMAKE_BUILD_TYPE=Debug .
@@ -34,7 +34,7 @@ jobs:
     name: "windows, release"
     runs-on: "windows-2019"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -G "Visual Studio 16 2019" -DCMAKE_BUILD_TYPE=Release .
@@ -54,7 +54,7 @@ jobs:
     name: "windows, release, static library"
     runs-on: "windows-2019"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -G "Visual Studio 16 2019" -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF .
@@ -74,7 +74,7 @@ jobs:
     name: "windows, all features disabled"
     runs-on: "windows-2019"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Configure
         run: |
           cmake -G "Visual Studio 16 2019" -DENABLE_JOURNALD_TARGETS=OFF -DENABLE_NETWORK_TARGETS=OFF -DENABLE_SOCKET_TARGETS=OFF -DCMAKE_BUILD_TYPE=Release -DENABLE_THREAD_SAFETY=OFF .
@@ -91,8 +91,8 @@ jobs:
     name: "windows, with c++"
     runs-on: "windows-2019"
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/[email protected].2
+      - uses: actions/checkout@v3
+      - uses: actions/[email protected].3
       - name: Install Gems
         run: |
           gem install bundler

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ easier:
  * completely thread safe
  * can be adjusted or removed during compilation for zero runtime impact
  * localized for multiple languages :brazil: :bulgaria: :cn: :czech_republic:
-   :de: :es: :fr: :greece: :india: :it: :poland: :sweden: :slovakia: :us:
+   :de: :es: :fr: :greece: :india: :it: :poland: :slovakia: :sweden: :us:
    ([add yours!](https://github.com/goatshriek/stumpless/blob/latest/docs/localization.md))
  * easy-access
    [documentation](https://goatshriek.github.io/stumpless/docs/c/latest/index.html),

diff --git a/docs/SECURITY.md b/docs/SECURITY.md
@@ -1,18 +1,21 @@
 # Stumpless Security Policy
+This document describes the security support for Stumpless, including versions
+that will be patched and the procedure for submitting vulnerabilities.
 
 ## Supported Versions
-
-The table below lists the current supported versions of Stumpless.
+The table below lists the current supported versions of Stumpless. Generally,
+the current and previous major versions are supported at their highest minor
+version.
 
 | Version | Supported          |
 | ------- | ------------------ |
 | 2.1.x   | :heavy_check_mark: |
-| 2.0.x   | :heavy_check_mark: |
+| 2.0.x   | :x:                |
 | 1.6.x   | :heavy_check_mark: |
 | <= 1.5  | :x:                |
 
-## Reporting a Vulnerability
 
+## Reporting a Vulnerability
 If you discover a problem with Stumpless, please report it immediately to the
 project owner, [Joel Anderson](mailto:[email protected]). The issue
 will be investigated as soon as possible and you will receive a response within