Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release version 0.4.0 #121

Merged
merged 36 commits into from
Jan 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
dfda95c
prepare changelog for next dev phase
cstender Jul 28, 2022
d9e48ba
Resolve "Add MIT license"
vornkat-iis Apr 27, 2023
6abff0b
Merge branch '48-add-mit-license' into 'dev'
Michael-M-Baron Apr 27, 2023
d60addd
Resolve "libjapi/doxydir example out of date"
vornkat-iis Jul 5, 2023
1a6f0ca
Merge branch '44-libjapi-doxydir-example-out-of-date' into 'dev'
Michael-M-Baron Jul 5, 2023
8d1c778
Resolve "Include errors using <>/"""
vornkat-iis Jul 5, 2023
5b83a42
Merge branch '46-include-errors-using' into 'dev'
Michael-M-Baron Jul 5, 2023
8b4420d
Resolve "Japi_pushsrv_destroy is not cleaning ctx->push_service element"
vornkat-iis Jul 5, 2023
0687def
Merge branch '43-japi_pushsrv_destroy-is-not-cleaning-ctx-push_servic…
Michael-M-Baron Jul 5, 2023
1dd087d
Resolve "Different behavior of push services in debug and release mode"
vornkat-iis Jul 7, 2023
e242bb6
Merge branch '42-different-behavior-of-push-services-in-debug-and-rel…
Michael-M-Baron Jul 7, 2023
e784a06
add clang-format as pre-commit hook
jannismain Jul 11, 2023
d311e27
Merge branch '50-add-make-format-target' into 'dev'
vornkat-iis Jul 11, 2023
3eb513f
Add and register default function japi_cmd_list
vornkat-iis Jul 4, 2023
f147abb
Disallow user commands from starting with "japi_"
vornkat-iis Jul 11, 2023
905a965
Register default handler
vornkat-iis Jul 11, 2023
79790e7
Revert checking for empty push service context in destroy as tests fail
vornkat-iis Jul 11, 2023
0dfade6
Update doxydir/1_usage.md
vornkat-iis Aug 16, 2023
276c051
Merge pull request #116 from Fraunhofer-IIS/27-provide-japi-handler-t…
vornkat-iis Aug 16, 2023
0e287d2
Add github action workflow
vornkat-iis Jul 12, 2023
3877632
Recommendations for VSCode extensions for CMake
vornkat-iis Jul 13, 2023
0f21279
Build RPM packages using centos:7 container
vornkat-iis Jul 14, 2023
b5ec39e
Add actions to publish pages
vornkat-iis Jul 16, 2023
0ae2e21
Use container for CMake action
vornkat-iis Aug 16, 2023
0bf3360
Remove temp pipeline actions
vornkat-iis Aug 16, 2023
d9f9c35
Cleanup old references and files from GitLab
vornkat-iis Aug 16, 2023
c7e01f4
Add make target coverage
vornkat-iis Aug 16, 2023
a6dec8c
Add code coverage report to Pages
vornkat-iis Aug 17, 2023
cb89ca9
Merge pull request #119 from Fraunhofer-IIS/add-github-actions
vornkat-iis Aug 21, 2023
a9f3245
Update doxydir/2_examples.md
vornkat-iis Aug 21, 2023
c4177eb
Merge pull request #120 from Fraunhofer-IIS/118-collect-code-coverage
vornkat-iis Aug 21, 2023
dc4cbb8
Prepare next release
vornkat-iis Aug 21, 2023
65561c2
clang run fir the first time
vornkat-iis Jan 19, 2024
d3e390e
Incorporate review
vornkat-iis Jan 19, 2024
f958788
run clang on tests for the first time
vornkat-iis Jan 19, 2024
5bf2e4b
Adjust test to changed return value
vornkat-iis Jan 19, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
BasedOnStyle: LLVM
ColumnLimit: 88
PointerAlignment: Right
UseTab: Always
IndentWidth: 4
TabWidth: 4
BreakBeforeBraces: Linux
AlignTrailingComments: false
40 changes: 40 additions & 0 deletions .github/workflows/CMake.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: CMake

on:
push:

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Release

jobs:
build:
# The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
# You can convert this to a matrix build if you need cross-platform coverage.
# See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
runs-on: ubuntu-latest
container:
image: ghcr.io/fraunhofer-iis/libjapi_ci
credentials:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v1
with:
submodules: true

- name: Configure CMake
# Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
# See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
run: cmake3 -B ${{ env.GITHUB_WORKSPACE }}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

- name: Build
# Build your program with the given configuration
run: cmake3 --build ${{ env.GITHUB_WORKSPACE }}/build --config ${{env.BUILD_TYPE}}

- name: Test
working-directory: ${{ env.GITHUB_WORKSPACE }}/build
# Execute tests defined by the CMake configuration.
# See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
run: make run_test
28 changes: 28 additions & 0 deletions .github/workflows/package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: package

on:
push:
branches: ["master", "dev"]

jobs:
package:
runs-on: ubuntu-latest
container:
image: ghcr.io/fraunhofer-iis/libjapi_ci
credentials:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v1
with:
submodules: true

- name: Build RPM package
run: ls -la; package/create_rpm.sh

- name: Upload package
uses: actions/upload-artifact@v3
with:
name: Binary RPM
path: package/rpmbuild/RPMS/x86_64/libjapi*.rpm
74 changes: 74 additions & 0 deletions .github/workflows/pages_static.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
push:
branches: ["master"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Debug

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
container:
image: ghcr.io/fraunhofer-iis/libjapi_ci
credentials:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v1
with:
submodules: true

- name: Install debug dependencies
run: yum -y install lcov

- name: Configure CMake
run: cmake3 -B ${{ env.GITHUB_WORKSPACE }}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

- name: Create Docs
working-directory: ${{ env.GITHUB_WORKSPACE }}/build
run: make doc

- name: Create Code Coverage Report
working-directory: ${{ env.GITHUB_WORKSPACE }}/build
run: |
make coverage &&
cp -r coverage doc/html

- name: Upload artifacts
uses: actions/upload-pages-artifact@v2
with:
path: '${{ env.GITHUB_WORKSPACE }}/build/doc/html/'


deploy:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest

steps:
- name: Setup Pages
uses: actions/configure-pages@v3

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
94 changes: 0 additions & 94 deletions .gitlab-ci.yml

This file was deleted.

6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
repos:
- repo: https://github.com/pre-commit/mirrors-clang-format
rev: v16.0.6
hooks:
- id: clang-format
args: [--style, file]
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"matepek.vscode-catch2-test-adapter",
"ms-vscode.cmake-tools",
"ms-vscode.cpptools"
]
}
17 changes: 17 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,20 @@ target_include_directories(testsuite
)

add_custom_target(run_test COMMAND testsuite DEPENDS testsuite)

################################
# Test code coverage #

if(CMAKE_BUILD_TYPE MATCHES "Debug")
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
include(${CMAKE_SOURCE_DIR}/cmake/CodeCoverage.cmake)
set(COVERAGE_EXCLUDES
"doxydir"
"/usr/include/*"
"googletest/*"
"test/*"
)
append_coverage_compiler_flags()

setup_target_for_coverage_lcov(NAME coverage EXECUTABLE testsuite)
endif()
20 changes: 20 additions & 0 deletions COPYING
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

Copyright (c) 2023 Fraunhofer IIS

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
17 changes: 15 additions & 2 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
next
=====
*

0.4.0
=====
* Add MIT license and publish to GitHub
* Add make target coverage
* Add githook for formatting with clang
* Move GitLab-CI to GitHub actions
* Add japi handler that lists registered commands
* Some fixes and doc update

0.3.2
=====
* Seperated doc in overview and details
* Using README as doxygen frontpage, removed duplicated content
* Fixed invalid memory access after a client disconnects
* Added build support for macOS
* Increased CMake requirement to version 3.6
* Using README as doxygen frontpage, removed duplicated content
* Improved doxygen documentation

0.3.1
=====
Expand Down
Loading