Merge pull request #45 from Ddoiron-cidco/master

updated from jenkins pipeline to github pipeline

Author: glabmoris

.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+    branches:
+      - master
+      - main
+  workflow_dispatch:
+
+jobs:
+  linux-build-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and run tests
+        run: make test
+
+      - name: Upload Linux test report
+        uses: actions/upload-artifact@v4
+        with:
+          name: linux-test-report
+          path: build/test/reports/sbet-test-linux-report.xml
+
+      - name: Upload Linux binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: linux-binaries
+          path: |
+            build/bin/sbet-decoder
+            build/bin/accuracy-decoder
+
+  windows-build-test:
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and run tests
+        shell: cmd
+        run: |
+          for /f "usebackq tokens=*" %%i in (`"%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -latest -property installationPath`) do set VS_INSTALL=%%i
+          call "%VS_INSTALL%\Common7\Tools\VsDevCmd.bat" -arch=x64 -host_arch=x64
+          if not exist build\bin mkdir build\bin
+          if not exist build\test\reports mkdir build\test\reports
+          cl /nologo /W4 /EHsc /std:c++14 /Fe:build\bin\sbet-decoder.exe src\sbet-decoder.cpp src\SbetProcessor.cpp
+          cl /nologo /W4 /EHsc /std:c++14 /Fe:build\bin\accuracy-decoder.exe src\accuracy-decoder.cpp
+          cl /nologo /W4 /EHsc /std:c++14 /DCATCH_CONFIG_NO_POSIX_SIGNALS /Fe:build\test\tests.exe test\CatchMain.cpp
+          build\test\tests.exe -r junit -o build\test\reports\sbet-test-windows-report.xml
+
+      - name: Upload Windows test report
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows-test-report
+          path: build/test/reports/sbet-test-windows-report.xml
+
+      - name: Upload Windows binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows-binaries
+          path: |
+            build/bin/sbet-decoder.exe
+            build/bin/accuracy-decoder.exe
+
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Doxygen
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen graphviz
+
+      - name: Generate docs
+        run: make doc
+
+      - name: Upload Doxygen output
+        uses: actions/upload-artifact@v4
+        with:
+          name: doxygen-output
+          path: build/doxygen

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+## [Unreleased]
+
+### Added
+- `CONTRIBUTING.md` with contribution workflow and quality checklist.
+- `doc/README.md` with SBET and accuracy output references.
+- `VERSION` file at repository root for the current project version.
+- GitHub Actions CI workflow for Linux, Windows, and documentation checks.
+- Additional CLI tests for usage output and missing-file behavior.
+
+### Changed
+- Expanded `README.md` with build, test, usage, and CI documentation.
+- Updated test build flags for compatibility with modern Linux toolchains.
+
+### Removed
+- Jenkins pipeline configuration (`Jenkinsfile`) in favor of GitHub Actions.

Doxyfile

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = build/doxygen
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -790,7 +790,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  =
+INPUT                  = src README.md CONTRIBUTING.md CHANGELOG.md doc/README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -864,7 +864,7 @@ FILE_PATTERNS          = *.c \
 # be searched for input files as well.
 # The default value is: NO.
 
-RECURSIVE              = NO
+RECURSIVE              = YES
 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
@@ -873,7 +873,7 @@ RECURSIVE              = NO
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = src/gui/build-SBET-Decoder-Desktop-Debug
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -889,7 +889,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = */build-*/* *.pro.user
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

Jenkinsfile

@@ -1,14 +1,19 @@
-CC=g++
-CFLAGS=-Wall
+CXX ?= g++
+CXXFLAGS ?= -Wall -Wextra -std=c++11
+TEST_CPPFLAGS ?= -DCATCH_CONFIG_NO_POSIX_SIGNALS
+
+.PHONY: default test clean doc deploy installation
 
 default:
 	mkdir -p build/bin
-	$(CC) $(CFLAGS) -o build/bin/sbet-decoder src/sbet-decoder.cpp src/SbetProcessor.cpp
-	$(CC) $(CFLAGS) -o build/bin/accuracy-decoder src/accuracy-decoder.cpp
+	$(CXX) $(CXXFLAGS) -o build/bin/sbet-decoder src/sbet-decoder.cpp src/SbetProcessor.cpp
+	$(CXX) $(CXXFLAGS) -o build/bin/accuracy-decoder src/accuracy-decoder.cpp
+
 test: clean default
 	mkdir -p build/test/reports
-	$(CC) $(CFLAGS) -o build/test/tests test/CatchMain.cpp
+	$(CXX) $(CXXFLAGS) $(TEST_CPPFLAGS) -o build/test/tests test/CatchMain.cpp
 	build/test/tests -r junit -o build/test/reports/sbet-test-linux-report.xml
+
 clean:
 	rm -rf build
 

Makefile

@@ -1,11 +1,13 @@
 
+.PHONY: default test clean doc deploy
+
 default:
 	if not exist "build\bin" mkdir build\bin
 	call "%windows10_x64_BUILD_TOOLS_ROOT%\\VC\\Auxiliary\\Build\\vcvarsall.bat" x64 && cd build\\bin &&cl ..\\..\\src\\sbet-decoder.cpp ..\\..\\src\\SbetProcessor.cpp /EHsc /Fesbet-decoder.exe
 	call "%windows10_x64_BUILD_TOOLS_ROOT%\\VC\\Auxiliary\\Build\\vcvarsall.bat" x64 && cd build\\bin &&cl ..\\..\\src\\accuracy-decoder.cpp /EHsc /Feaccuracy-decoder.exe
 test: clean default
 	if not exist "build\test\reports" mkdir build\test\reports
-	call "%windows10_x64_BUILD_TOOLS_ROOT%\\VC\\Auxiliary\\Build\\vcvarsall.bat" x64 && cd build\\test &&cl ..\\..\\test\\CatchMain.cpp /EHsc /Fetests.exe
+	call "%windows10_x64_BUILD_TOOLS_ROOT%\\VC\\Auxiliary\\Build\\vcvarsall.bat" x64 && cd build\\test &&cl ..\\..\\test\\CatchMain.cpp /EHsc /DCATCH_CONFIG_NO_POSIX_SIGNALS /Fetests.exe
 	build\test\tests.exe -r junit -o build\\test\\reports\\sbet-test-windows-x64-reports.xml
 
 clean:

MakefileWindows

@@ -1,5 +1,65 @@
 # SBET-decoder
 
-Converts a Smoothed Best Estimated Trajectory (SBET) file to ASCII
+`SBET-decoder` converts binary Smoothed Best Estimated Trajectory (SBET) files
+and associated accuracy files into plain-text tables.
 
-sbet-decoder.exe input-file > output.txt
+The repository provides two command-line tools:
+- `sbet-decoder`: decodes SBET trajectory entries.
+- `accuracy-decoder`: decodes SBET accuracy entries.
+
+Current project version is stored in `VERSION`.
+Versioning rules are documented in `VERSION.md`.
+
+## Requirements
+
+- Linux: `g++`, `make`
+- Optional for API docs: `doxygen`
+- Windows (native build): Visual Studio C++ Build Tools and `nmake`/`make`
+
+## Build
+
+```bash
+make
+```
+
+This produces:
+- `build/bin/sbet-decoder`
+- `build/bin/accuracy-decoder`
+
+## Run
+
+```bash
+build/bin/sbet-decoder path/to/file.out > sbet.txt
+build/bin/accuracy-decoder path/to/file.out > accuracy.txt
+```
+
+If no input file is provided, each binary prints usage information.
+
+## Tests
+
+```bash
+make test
+```
+
+Test reports are written to:
+- `build/test/reports/sbet-test-linux-report.xml`
+
+## Documentation
+
+Generate Doxygen documentation:
+
+```bash
+make doc
+```
+
+Additional format examples are documented in `doc/README.md`.
+
+## CI
+
+Continuous integration is provided with GitHub Actions in
+`.github/workflows/ci.yml`.
+It uses GitHub-hosted runners only (no self-hosted runner required).
+The workflow validates:
+- Linux build and tests
+- Windows build and tests
+- Doxygen documentation generation

README.md

@@ -0,0 +1 @@
+0.1.0

VERSION

@@ -0,0 +1,26 @@
+# Versioning
+
+Current project version: `0.1.0`
+
+The canonical machine-readable version is stored in the root `VERSION` file.
+CI and automation scripts must read the version from `VERSION`.
+
+## Push Change Log
+
+Use this file to list the effective changes introduced at each push.
+
+### 2026-02-19 - Version 0.1.0
+
+- Added GitHub Actions CI workflow (`.github/workflows/ci.yml`) for Linux, Windows, and documentation jobs.
+- Removed Jenkins pipeline configuration (`Jenkinsfile`).
+- Expanded project documentation (`README.md`, `CONTRIBUTING.md`, `doc/README.md`).
+- Added version tracking files (`VERSION`, `VERSION.md`) and updated `CHANGELOG.md`.
+- Improved test coverage for CLI usage and missing-input behavior.
+- Updated build/test flags to keep test compilation compatible with modern Linux environments.
+
+## Update Rule
+
+For every push:
+1. Add a new entry in `Push Change Log` with date and version.
+2. List the concrete changes included in that push.
+3. Keep `VERSION` and the version header in this file aligned when version changes.

VERSION.md

@@ -0,0 +1,25 @@
+# Data Format Notes
+
+This directory contains reference material for the decoded output format.
+
+## SBET Output
+
+`src/SbetPrinter.hpp` prints one line per SBET entry with this header:
+
+`Time Latitude Longitude Altitude SpeedX SpeedY SpeedZ Heading Pitch Roll Wander ForceX ForceY ForceZ AngularRateX AngularRateY AngularRateZ`
+
+Values for latitude and longitude are converted from radians to degrees.
+
+Reference image:
+- `doc/sbet-format.png`
+
+## Accuracy Output
+
+`src/AccuracyPrinter.hpp` prints one line per accuracy entry with this header:
+
+`Time NorthingSD EastingSD AltitudeSD SpeedNorthSD SpeedEastSD SpeedAltitudeSD RollSd PitchSd HeadingSd`
+
+Roll, pitch, and heading standard deviations are scaled by `1/60`.
+
+Reference image:
+- `doc/accuracy-out-format.png`