8000 Adding workflow files, fixing up tests · connectivecpp/binary-serialize@a83153a · GitHub
[go: up one dir, main page]
Skip to content

Commit a83153a

Browse files
cliffg-softwarelibrecliffg-softwarelibre
committed
Adding workflow files, fixing up tests
1 parent 71737ea commit a83153a

File tree

4 files changed

+63
-3
lines changed

4 files changed

+63
-3
lines changed

‎.github/workflows/build_run_unit_test_cmake.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Build, run unit tests
2+
name: CMake build and run unit test matrix
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
- develop
9+
env:
10+
BUILD_TYPE: Release
11+
jobs:
12+
build_matrix:
13+
strategy:
14+
matrix:
15+
os: [ubuntu-latest, windows-latest, macos-14]
16+
runs-on: ${{ matrix.os }}
17+
defaults:
18+
run:
19+
shell: bash
20+
steps:
21+
- name: checkout
22+
uses: actions/checkout@v4
23+
- name: create-build-dir
24+
run: mkdir build
25+
- name: configure-cmake
26+
run: cd build && cmake -D BINARY_SERIALIZE_BUILD_TESTS:BOOL=ON -D BINARY_SERIALIZE_BUILD_EXAMPLES:BOOL=ON ..
27+
- name: build
28+
run: cd build && cmake --build . --config $BUILD_TYPE
29+
- name: run-unit-test
30+
run: cd build && ctest -C $BUILD_TYPE

‎.github/workflows/gen_docs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Build, run unit tests
2+
name: Generate documentation
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
jobs:
9+
build_matrix:
10+
strategy:
11+
matrix:
12+
os: [ubuntu-latest]
13+
runs-on: ${{ matrix.os }}
14+
defaults:
15+
run:
16+
shell: bash
17+
steps:
18+
- name: checkout
19+
uses: actions/checkout@v4
20+
- name: run-doxygen
21+
uses: mattnotmitt/doxygen-action@v1.9.8
22+
with:
23+
working-directory: doc
24+
- name: deploy-pages
25+
uses: peaceiris/actions-gh-pages@v4
26+
with:
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: ./doc/doc_output/html

‎README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,17 @@
1212

1313
## Overview
1414

15-
The
15+
The `binary_serialize` functions and classes provide serializing and unserializing of binary data. Serialization provides a way to transform application objects into and out of byte streams that can be sent over a network (or used for file IO).
16+
17+
The serialization functionality in this repository is useful when explicit control is needed for every bit and byte. This allows a developer to match an existing wire protocol or encoding scheme or to define his or her own wire protocol. Support is provided for fundamental arithmetic types as well as certain C++ vocabulary types such as `std::optional`. Both big and little endian support is provided.
1618

1719
## Generated Documentation
1820

1921
The generated Doxygen documentation for `binary_serialize` is [here](https://connectivecpp.github.io/binary-serialize/).
2022

2123
## Dependencies
2224

23-
The `binary_serialize` header file does not have any third-party dependencies. It uses C++ standard library headers only. The unit test code does have dependencies as noted below.
25+
The `binary_serialize` header files do not have any third-party dependencies. It uses C++ standard library headers only. The unit test code does have dependencies as noted below.
2426

2527
## C++ Standard
2628

‎test/extract_append_test.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
#include <cstddef> // std::byte
1818
#include <cstdint> // std::uint32_t, etc
1919

20-
#include "marshall/extract_append.hpp"
20+
#include "serialize/extract_append.hpp"
2121
#include "utility/repeat.hpp"
2222
#include "utility/make_byte_array.hpp"
2323
#include "utility/cast_ptr_to.hpp"

0 commit comments

Comments
 (0)
0