From efdfa507dd5c534dd775bf817d155a34f9a1e6be Mon Sep 17 00:00:00 2001 From: Hennadii Chernyshchyk Date: Wed, 6 Apr 2022 00:04:31 +0300 Subject: Switch to Doxygen to avoid documentation duplication I also had to fix syntax a little in markdown and the header file. Now checked on CI. --- .github/workflows/build.yml | 92 ------------------------------------ .github/workflows/main.yml | 110 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 110 insertions(+), 92 deletions(-) delete mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/main.yml (limited to '.github/workflows') diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index dfa770a..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,92 +0,0 @@ -name: "CI: Build Test" - -on: - push: - branches-ignore: - - "releases/**" - paths-ignore: - - "**.md" - pull_request: - paths-ignore: - - "**.md" - -jobs: - build: - strategy: - matrix: - qt_version: [5.12.6, 5.15.0, 6.0.0, 6.2.0] - platform: [ubuntu-20.04, windows-latest, macos-latest] - include: - - qt_version: 6.0.0 - additional_arguments: -D QT_DEFAULT_MAJOR_VERSION=6 - - qt_version: 6.2.0 - additional_arguments: -D QT_DEFAULT_MAJOR_VERSION=6 - - platform: ubuntu-20.04 - make: make - CXXFLAGS: -Wall -Wextra -pedantic -Werror - MAKEFLAGS: -j2 - - platform: macos-latest - make: make - CXXFLAGS: -Wall -Wextra -pedantic -Werror - MAKEFLAGS: -j3 - - platform: windows-latest - make: nmake - CXXFLAGS: /W4 /WX /MP - - runs-on: ${{ matrix.platform }} - env: - CXXFLAGS: ${{ matrix.CXXFLAGS }} - MAKEFLAGS: ${{ matrix.MAKEFLAGS }} - - steps: - - name: Clone repo - uses: actions/checkout@v2.3.4 - - - name: Install Qt - uses: jurplel/install-qt-action@v2.14.0 - with: - version: ${{ matrix.qt_version }} - - - name: Build library with CMake - run: | - cmake . ${{ matrix.additional_arguments }} - cmake --build . - - - name: Build basic example with CMake - working-directory: examples/basic/ - run: | - cmake . ${{ matrix.additional_arguments }} - cmake --build . - - - name: Build calculator example CMake - working-directory: examples/calculator/ - run: | - cmake . ${{ matrix.additional_arguments }} - cmake --build . - - - name: Build sending_arguments example with CMake - working-directory: examples/sending_arguments/ - run: | - cmake . ${{ matrix.additional_arguments }} - cmake --build . - - - name: Setup MSVC environment for QMake - uses: ilammy/msvc-dev-cmd@v1 - - - name: Build basic example with QMake - working-directory: examples/basic/ - run: | - qmake - ${{ matrix.make }} - - - name: Build calculator example QMake - working-directory: examples/calculator/ - run: | - qmake - ${{ matrix.make }} - - - name: Build sending_arguments example with QMake - working-directory: examples/sending_arguments/ - run: | - qmake - ${{ matrix.make }} diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..d16aa6f --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,110 @@ +name: "CI: Build Test" + +on: + push: + branches-ignore: + - "releases/**" + paths-ignore: + - "**.md" + pull_request: + paths-ignore: + - "**.md" + +jobs: + doxygen: + name: Doxygen + runs-on: ubuntu-20.04 + steps: + - name: Clone repo + uses: actions/checkout@v2.3.4 + + - name: Install apt packages + run: | + sudo apt-get update + sudo apt-get install doxygen qtbase5-dev + + - name: Generate documentation + run: | + cmake -B build -D DOXYGEN_WARN_AS_ERROR=YES + cmake --build build --target SingleApplicationDocumentation + + build: + name: Build + strategy: + matrix: + qt_version: [5.12.6, 5.15.0, 6.0.0, 6.2.0] + platform: [ubuntu-20.04, windows-latest, macos-latest] + include: + - qt_version: 6.0.0 + additional_arguments: -D QT_DEFAULT_MAJOR_VERSION=6 + - qt_version: 6.2.0 + additional_arguments: -D QT_DEFAULT_MAJOR_VERSION=6 + - platform: ubuntu-20.04 + make: make + CXXFLAGS: -Wall -Wextra -pedantic -Werror + MAKEFLAGS: -j2 + - platform: macos-latest + make: make + CXXFLAGS: -Wall -Wextra -pedantic -Werror + MAKEFLAGS: -j3 + - platform: windows-latest + make: nmake + CXXFLAGS: /W4 /WX /MP + + runs-on: ${{ matrix.platform }} + env: + CXXFLAGS: ${{ matrix.CXXFLAGS }} + MAKEFLAGS: ${{ matrix.MAKEFLAGS }} + + steps: + - name: Clone repo + uses: actions/checkout@v2.3.4 + + - name: Install Qt + uses: jurplel/install-qt-action@v2.14.0 + with: + version: ${{ matrix.qt_version }} + + - name: Build library with CMake + run: | + cmake . ${{ matrix.additional_arguments }} + cmake --build . + + - name: Build basic example with CMake + working-directory: examples/basic/ + run: | + cmake . ${{ matrix.additional_arguments }} + cmake --build . + + - name: Build calculator example CMake + working-directory: examples/calculator/ + run: | + cmake . ${{ matrix.additional_arguments }} + cmake --build . + + - name: Build sending_arguments example with CMake + working-directory: examples/sending_arguments/ + run: | + cmake . ${{ matrix.additional_arguments }} + cmake --build . + + - name: Setup MSVC environment for QMake + uses: ilammy/msvc-dev-cmd@v1 + + - name: Build basic example with QMake + working-directory: examples/basic/ + run: | + qmake + ${{ matrix.make }} + + - name: Build calculator example QMake + working-directory: examples/calculator/ + run: | + qmake + ${{ matrix.make }} + + - name: Build sending_arguments example with QMake + working-directory: examples/sending_arguments/ + run: | + qmake + ${{ matrix.make }} -- cgit v1.2.1 From 4dea902f00e3ee16fec017d307bd6d132547c369 Mon Sep 17 00:00:00 2001 From: Itay Grudev Date: Tue, 7 Jun 2022 16:22:44 +0300 Subject: Moved Doxygen to separate workflow --- .github/workflows/doxygen.yml | 38 ++++++++++++++++++++++++++++++++++++++ .github/workflows/main.yml | 18 ------------------ 2 files changed, 38 insertions(+), 18 deletions(-) create mode 100644 .github/workflows/doxygen.yml (limited to '.github/workflows') diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml new file mode 100644 index 0000000..c47f809 --- /dev/null +++ b/.github/workflows/doxygen.yml @@ -0,0 +1,38 @@ +name: "Documentation" + +on: + push: + branches: + - 'main' + - 'master' + +jobs: + doxygen: + name: Doxygen + runs-on: ubuntu-22.04 + steps: + - name: Clone repo + uses: actions/checkout@v3 + + - name: Install doxygen and pre-requsites packages + run: | + sudo apt-get update + sudo apt-get install doxygen qtbase5-dev + + - name: Generate documentation + run: | + cmake -B build -D DOXYGEN_WARN_AS_ERROR=YES + cmake --build build --target SingleApplicationDocumentation + + - name: Deploy to GitHub pages + on: + branches: + - master + + uses: crazy-max/ghaction-github-pages@v3 + with: + target_branch: gh-pages + build_dir: build/html + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d16aa6f..7be1a28 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -10,24 +10,6 @@ on: paths-ignore: - "**.md" -jobs: - doxygen: - name: Doxygen - runs-on: ubuntu-20.04 - steps: - - name: Clone repo - uses: actions/checkout@v2.3.4 - - - name: Install apt packages - run: | - sudo apt-get update - sudo apt-get install doxygen qtbase5-dev - - - name: Generate documentation - run: | - cmake -B build -D DOXYGEN_WARN_AS_ERROR=YES - cmake --build build --target SingleApplicationDocumentation - build: name: Build strategy: -- cgit v1.2.1 From a2a5d139c3c0ebb4016da30023e7e8fff00a6c91 Mon Sep 17 00:00:00 2001 From: Itay Grudev Date: Tue, 7 Jun 2022 16:25:11 +0300 Subject: Fixed typo in main.yml workflow --- .github/workflows/main.yml | 1 + 1 file changed, 1 insertion(+) (limited to '.github/workflows') diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 7be1a28..d6fe0de 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -10,6 +10,7 @@ on: paths-ignore: - "**.md" +jobs: build: name: Build strategy: -- cgit v1.2.1