Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
2,736 changes: 0 additions & 2,736 deletions .github/doxygen/Doxyfile

This file was deleted.

Binary file removed .github/doxygen/logo.png
Binary file not shown.
35 changes: 0 additions & 35 deletions .github/scripts/check_version.sh

This file was deleted.

9 changes: 0 additions & 9 deletions .github/scripts/patch_doxyfile.sh

This file was deleted.

38 changes: 0 additions & 38 deletions .github/scripts/prepare_doxygen.sh

This file was deleted.

48 changes: 6 additions & 42 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
@@ -1,50 +1,14 @@
name: Build and test code
name: Build and Test code

on:
push:
branches:
- main
pull_request:

jobs:
build:

strategy:
matrix:
env:
- toolchain: "toolchain/gcc-linux.cmake"
runner: ubuntu-latest
generator: ""
- toolchain: "toolchain/clang-macos.cmake"
runner: macos-latest
generator: ""
- toolchain: "\"toolchain/clang-windows.cmake\""
runner: windows-latest
generator: "-G \"Visual Studio 17 2022\""

runs-on: ${{ matrix.env.runner }}

steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Install Linux reqs
if: ${{ matrix.env.runner == 'ubuntu-latest' }}
run: |
sudo apt-get update
sudo apt-get install -y clang cmake cppcheck clang-format clang-tidy gcc pre-commit

- name: Install macOS reqs
if: ${{ matrix.env.runner == 'macos-latest' }}
run: |
brew install llvm cmake cppcheck clang-format gcc pre-commit

- name: Build
run: |
cmake ${{ matrix.env.generator }} -B build -S . -DCMAKE_TOOLCHAIN_FILE=${{ matrix.env.toolchain }}
cmake --build build -j8

- name: Run Linux/macOS tests
if: ${{ matrix.env.runner == 'ubuntu-latest' || matrix.env.runner == 'macos-latest' }}
run: |
./build/bin/keyplecommoncppapi_ut
jobs:
call-reusable-workflow:
uses: eclipse-keyple/keyple-actions/.github/workflows/reusable-cpp-build-and-test.yml@main # NOSONAR - Same organization, trusted source
with:
test_executable_name: 'build/bin/keyplecommoncppapi_ut'
49 changes: 8 additions & 41 deletions .github/workflows/publish-doc-release.yml
Original file line number Diff line number Diff line change
@@ -1,47 +1,14 @@
name: Publish API documentation

name: Publish API documentation (release)
on:
release:
types: [published]

permissions:
checks: write

jobs:
publish-doc-release:
runs-on: ubuntu-latest
steps:
- name: Check out repository code from ${{ github.repository }}/${{ github.ref }}
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Make scripts executable
run: chmod +x ./.github/scripts/*.sh

- name: Check version
working-directory: .
run: ./.github/scripts/check_version.sh $(echo "${{ github.ref }}" | sed -e "s,^refs/tags/,,")

- name: Patch Doxyfile
working-directory: .
run: ./.github/scripts/patch_doxyfile.sh ${{ env.PROJECT_VERSION }}

- name: Generate and prepare documentation
uses: eclipse-keypop/keypop-actions/doxygen@f012732e75cdda39ba7b988533030493303700a5
with:
repo-name: ${{ github.event.repository.name }}
version: ${{ github.event.inputs.version || github.ref_name }}

- name: Prepare Doxygen doc page locally
working-directory: .
run: ./.github/scripts/prepare_doxygen.sh ${{ env.PROJECT_VERSION }}

- name: Deploy to doc branch
run: |
git config --global user.name "Eclipse Keypop Bot"
git config --global user.email "${{ github.repository }}-bot@eclipse.org"
cd ${{ github.event.repository.name }}
git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
git add .
git commit -m "docs: update ${{ github.event.inputs.version || github.ref_name }} documentation"
git push origin doc --force
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
uses: eclipse-keyple/keyple-actions/.github/workflows/reusable-publish-doxygen.yml@main # NOSONAR - Same organization, trusted source
with:
version: ${{ github.event.inputs.version || github.ref_name }}
secrets: inherit # NOSONAR - Same organization, trusted source
48 changes: 6 additions & 42 deletions .github/workflows/publish-doc-snapshot.yml
Original file line number Diff line number Diff line change
@@ -1,50 +1,14 @@
name: Publish API documentation (snapshot)

on:
push:
branches:
- main
- master
- doxygen
workflow_dispatch:

permissions:
checks: write

jobs:
publish-doc-snapshot:
runs-on: ubuntu-latest
steps:
- name: Check out repository code from ${{ github.repository }}/${{ github.ref }}
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Make scripts executable
run: chmod +x ./.github/scripts/*.sh

- name: Check version
working-directory: .
run: ./.github/scripts/check_version.sh

- name: Patch Doxyfile
working-directory: .
run: ./.github/scripts/patch_doxyfile.sh ${{ env.PROJECT_VERSION }}

- name: Generate and prepare documentation
uses: eclipse-keypop/keypop-actions/doxygen@f012732e75cdda39ba7b988533030493303700a5
with:
repo-name: ${{ github.event.repository.name }}
version: ${{ github.event.inputs.version || github.ref_name }}

- name: Prepare Doxygen doc page locally
working-directory: .
run: ./.github/scripts/prepare_doxygen.sh ${{ env.PROJECT_VERSION }}

- name: Deploy to doc branch
run: |
git config --global user.name "Eclipse Keypop Bot"
git config --global user.email "${{ github.repository }}-bot@eclipse.org"
cd ${{ github.event.repository.name }}
git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
git add .
git diff --quiet && git diff --staged --quiet || git commit -m "docs: update snapshot documentation"
git push origin doc --force
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
uses: eclipse-keyple/keyple-actions/.github/workflows/reusable-publish-doxygen.yml@main # NOSONAR - Same organization, trusted source
secrets: inherit # NOSONAR - Same organization, trusted source
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PROJECT(KeypleCommonCppApi C CXX)

SET(CMAKE_PROJECT_VERSION_MAJOR "2")
SET(CMAKE_PROJECT_VERSION_MINOR "0")
SET(CMAKE_PROJECT_VERSION_PATCH "1")
SET(CMAKE_PROJECT_VERSION_PATCH "2")

SET(CMAKE_PROJECT_VERSION "${CMAKE_PROJECT_VERSION_MAJOR}.
${CMAKE_PROJECT_VERSION_MINOR}.
Expand Down
22 changes: 22 additions & 0 deletions src/main/mainpage.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/**
* @mainpage Keyple Common C++ API
*
* @section overview Overview
*
* The **Keyple Common C++ API** contains the interfaces of the objects that
* are involved in the public interactions between different Keyple components,
* providing the foundation for component communication.
*
* @section key_features Key Features
*
* - Common interfaces for Keyple components
* - Plugin and reader extension points
* - Standard component interaction contracts
* - Base API for Keyple architecture
* - Cross-component communication interfaces
*
* @section resources Resources
*
* - **Documentation**: [keyple.org](https://keyple.org)
* - **API Documentation**: [docs.keyple.org/keyple-common-cpp-api](https://docs.keyple.org/keyple-common-cpp-api)
*/
Loading