build: add doxygen target #9549
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: Build | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - "bugfix-release/*" | |
| - "release/*" | |
| pull_request: | |
| workflow_dispatch: | |
| merge_group: | |
| concurrency: | |
| group: build-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| C2_ENABLE_LTO: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/bugfix-release/') || startsWith(github.ref, 'refs/heads/release/') }} | |
| CHATTERINO_REQUIRE_CLEAN_GIT: On | |
| C2_BUILD_WITH_QT6: Off | |
| # Last known good conan version | |
| # 2.0.3 has a bug on Windows (conan-io/conan#13606) | |
| CONAN_VERSION: 2.0.2 | |
| jobs: | |
| build-ubuntu-docker: | |
| name: "Build Ubuntu in Docker" | |
| runs-on: ubuntu-latest | |
| container: ${{ matrix.container }} | |
| strategy: | |
| matrix: | |
| include: | |
| - os: ubuntu-20.04 | |
| container: ghcr.io/chatterino/chatterino2-build-ubuntu-20.04:latest | |
| qt-version: 6.6.1 | |
| force-lto: false | |
| plugins: true | |
| skip-artifact: false | |
| skip-crashpad: false | |
| build-appimage: false | |
| build-deb: true | |
| - os: ubuntu-22.04 | |
| container: ghcr.io/chatterino/chatterino2-build-ubuntu-22.04:latest | |
| qt-version: 6.6.1 | |
| force-lto: false | |
| plugins: true | |
| skip-artifact: false | |
| skip-crashpad: false | |
| build-appimage: true | |
| build-deb: true | |
| env: | |
| C2_ENABLE_LTO: ${{ matrix.force-lto }} | |
| C2_PLUGINS: ${{ matrix.plugins }} | |
| C2_ENABLE_CRASHPAD: ${{ matrix.skip-crashpad == false }} | |
| C2_BUILD_WITH_QT6: ${{ startsWith(matrix.qt-version, '6.') }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 # allows for tags access | |
| - name: Build | |
| run: | | |
| mkdir build | |
| cd build | |
| CXXFLAGS=-fno-sized-deallocation cmake \ | |
| -DCMAKE_INSTALL_PREFIX=appdir/usr/ \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DPAJLADA_SETTINGS_USE_BOOST_FILESYSTEM=On \ | |
| -DUSE_PRECOMPILED_HEADERS=OFF \ | |
| -DCMAKE_EXPORT_COMPILE_COMMANDS=On \ | |
| -DCHATTERINO_LTO="$C2_ENABLE_LTO" \ | |
| -DCHATTERINO_PLUGINS="$C2_PLUGINS" \ | |
| -DCMAKE_PREFIX_PATH="$Qt6_DIR/lib/cmake" \ | |
| -DBUILD_WITH_QT6="$C2_BUILD_WITH_QT6" \ | |
| -DCHATTERINO_STATIC_QT_BUILD=On \ | |
| .. | |
| make -j"$(nproc)" | |
| - name: Package - AppImage (Ubuntu) | |
| if: matrix.build-appimage | |
| run: | | |
| cd build | |
| sh ./../.CI/CreateAppImage.sh | |
| - name: Upload artifact - AppImage (Ubuntu) | |
| if: matrix.build-appimage | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Chatterino-x86_64-Qt-${{ matrix.qt-version }}.AppImage | |
| path: build/Chatterino-x86_64.AppImage | |
| - name: Package - .deb (Ubuntu) | |
| if: matrix.build-deb | |
| run: | | |
| cd build | |
| sh ./../.CI/CreateUbuntuDeb.sh | |
| - name: Upload artifact - .deb (Ubuntu) | |
| if: matrix.build-deb | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Chatterino-${{ matrix.os }}-Qt-${{ matrix.qt-version }}.deb | |
| path: build/Chatterino-${{ matrix.os }}-x86_64.deb | |
| build: | |
| name: "Build ${{ matrix.os }}, Qt ${{ matrix.qt-version }} (LTO:${{ matrix.force-lto }}, crashpad:${{ matrix.skip-crashpad && 'off' || 'on' }})" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| include: | |
| # macOS | |
| - os: macos-13 | |
| qt-version: 5.15.2 | |
| force-lto: false | |
| plugins: false | |
| skip-artifact: false | |
| skip-crashpad: false | |
| # Windows | |
| - os: windows-latest | |
| qt-version: 6.5.0 | |
| force-lto: false | |
| plugins: false | |
| skip-artifact: false | |
| skip-crashpad: false | |
| # Windows 7/8 | |
| - os: windows-latest | |
| qt-version: 5.15.2 | |
| force-lto: false | |
| plugins: false | |
| skip-artifact: false | |
| skip-crashpad: true | |
| fail-fast: false | |
| env: | |
| C2_ENABLE_LTO: ${{ matrix.force-lto }} | |
| C2_PLUGINS: ${{ matrix.plugins }} | |
| C2_ENABLE_CRASHPAD: ${{ matrix.skip-crashpad == false }} | |
| C2_BUILD_WITH_QT6: ${{ startsWith(matrix.qt-version, '6.') }} | |
| C2_USE_OPENSSL3: ${{ startsWith(matrix.qt-version, '6.') && 'True' || 'False' }} | |
| C2_CONAN_CACHE_SUFFIX: ${{ startsWith(matrix.qt-version, '6.') && '-QT6' || '' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 # allows for tags access | |
| - name: Install Qt5 | |
| if: startsWith(matrix.qt-version, '5.') | |
| uses: jurplel/[email protected] | |
| with: | |
| cache: true | |
| cache-key-prefix: ${{ runner.os }}-QtCache-${{ matrix.qt-version }}-v2 | |
| version: ${{ matrix.qt-version }} | |
| - name: Install Qt 6.5.3 imageformats | |
| if: startsWith(matrix.qt-version, '6.') | |
| uses: jurplel/[email protected] | |
| with: | |
| cache: false | |
| modules: qtimageformats | |
| set-env: false | |
| version: 6.5.3 | |
| extra: --noarchives | |
| - name: Find Qt 6.5.3 Path | |
| if: startsWith(matrix.qt-version, '6.') && startsWith(matrix.os, 'windows') | |
| shell: pwsh | |
| id: find-good-imageformats | |
| run: | | |
| cd "$Env:RUNNER_WORKSPACE/Qt/6.5.3" | |
| cd (Get-ChildItem)[0].Name | |
| cd plugins/imageformats | |
| echo "PLUGIN_PATH=$(pwd)" | Out-File -Path "$Env:GITHUB_OUTPUT" -Encoding ASCII | |
| - name: Install Qt6 | |
| if: startsWith(matrix.qt-version, '6.') | |
| uses: jurplel/[email protected] | |
| with: | |
| cache: true | |
| cache-key-prefix: ${{ runner.os }}-QtCache-${{ matrix.qt-version }}-v2 | |
| modules: qt5compat qtimageformats | |
| version: ${{ matrix.qt-version }} | |
| # WINDOWS | |
| - name: Enable Developer Command Prompt (Windows) | |
| if: startsWith(matrix.os, 'windows') | |
| uses: ilammy/[email protected] | |
| - name: Setup sccache (Windows) | |
| # sccache v0.7.4 | |
| uses: hendrikmuhs/[email protected] | |
| if: startsWith(matrix.os, 'windows') | |
| with: | |
| variant: sccache | |
| # only save on on the default (master) branch | |
| save: ${{ github.event_name == 'push' }} | |
| key: sccache-build-${{ matrix.os }}-${{ matrix.qt-version }}-${{ matrix.skip-crashpad }} | |
| restore-keys: | | |
| sccache-build-${{ matrix.os }}-${{ matrix.qt-version }} | |
| - name: Cache conan packages (Windows) | |
| if: startsWith(matrix.os, 'windows') | |
| uses: actions/cache@v4 | |
| with: | |
| key: ${{ runner.os }}-conan-user-${{ hashFiles('**/conanfile.py') }}${{ env.C2_CONAN_CACHE_SUFFIX }} | |
| path: ~/.conan2/ | |
| - name: Install Conan (Windows) | |
| if: startsWith(matrix.os, 'windows') | |
| run: | | |
| python3 -c "import site; import sys; print(f'{site.USER_BASE}\\Python{sys.version_info.major}{sys.version_info.minor}\\Scripts')" >> "$GITHUB_PATH" | |
| pip3 install --user "conan==${{ env.CONAN_VERSION }}" | |
| shell: powershell | |
| - name: Setup Conan (Windows) | |
| if: startsWith(matrix.os, 'windows') | |
| run: | | |
| conan --version | |
| conan profile detect -f | |
| shell: powershell | |
| - name: Install dependencies (Windows) | |
| if: startsWith(matrix.os, 'windows') | |
| run: | | |
| mkdir build | |
| cd build | |
| conan install .. ` | |
| -s build_type=RelWithDebInfo ` | |
| -c tools.cmake.cmaketoolchain:generator="NMake Makefiles" ` | |
| -b missing ` | |
| --output-folder=. ` | |
| -o with_openssl3="$Env:C2_USE_OPENSSL3" | |
| shell: powershell | |
| - name: Build (Windows) | |
| if: startsWith(matrix.os, 'windows') | |
| shell: pwsh | |
| run: | | |
| cd build | |
| cmake ` | |
| -G"NMake Makefiles" ` | |
| -DCMAKE_BUILD_TYPE=RelWithDebInfo ` | |
| -DCMAKE_TOOLCHAIN_FILE="conan_toolchain.cmake" ` | |
| -DUSE_PRECOMPILED_HEADERS=ON ` | |
| -DBUILD_WITH_CRASHPAD="$Env:C2_ENABLE_CRASHPAD" ` | |
| -DCHATTERINO_LTO="$Env:C2_ENABLE_LTO" ` | |
| -DCHATTERINO_PLUGINS="$Env:C2_PLUGINS" ` | |
| -DBUILD_WITH_QT6="$Env:C2_BUILD_WITH_QT6" ` | |
| .. | |
| set cl=/MP | |
| nmake /S /NOLOGO | |
| - name: Build crashpad (Windows) | |
| if: startsWith(matrix.os, 'windows') && !matrix.skip-crashpad | |
| shell: pwsh | |
| run: | | |
| cd build | |
| set cl=/MP | |
| nmake /S /NOLOGO chatterino-crash-handler | |
| mkdir Chatterino2/crashpad | |
| cp bin/crashpad/crashpad-handler.exe Chatterino2/crashpad/crashpad-handler.exe | |
| 7z a bin/chatterino-Qt-${{ matrix.qt-version }}.pdb.7z bin/chatterino.pdb | |
| - name: Prepare build dir (windows) | |
| if: startsWith(matrix.os, 'windows') | |
| run: | | |
| cd build | |
| windeployqt bin/chatterino.exe --release --no-compiler-runtime --no-translations --no-opengl-sw --dir Chatterino2/ | |
| cp bin/chatterino.exe Chatterino2/ | |
| echo nightly > Chatterino2/modes | |
| - name: Fix Qt6 (windows) | |
| if: startsWith(matrix.qt-version, '6.') && startsWith(matrix.os, 'windows') | |
| working-directory: build | |
| run: | | |
| cp ${{ steps.find-good-imageformats.outputs.PLUGIN_PATH }}/qwebp.dll Chatterino2/imageformats/qwebp.dll | |
| - name: Package (windows) | |
| if: startsWith(matrix.os, 'windows') | |
| working-directory: build | |
| run: | | |
| 7z a chatterino-windows-x86-64-Qt-${{ matrix.qt-version }}.zip Chatterino2/ | |
| - name: Upload artifact (Windows - binary) | |
| if: startsWith(matrix.os, 'windows') && !matrix.skip-artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: chatterino-windows-x86-64-Qt-${{ matrix.qt-version }}.zip | |
| path: build/chatterino-windows-x86-64-Qt-${{ matrix.qt-version }}.zip | |
| - name: Upload artifact (Windows - symbols) | |
| if: startsWith(matrix.os, 'windows') && !matrix.skip-artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: chatterino-windows-x86-64-Qt-${{ matrix.qt-version }}-symbols.pdb.7z | |
| path: build/bin/chatterino-Qt-${{ matrix.qt-version }}.pdb.7z | |
| - name: Clean Conan cache | |
| if: startsWith(matrix.os, 'windows') | |
| run: conan cache clean --source --build --download "*" | |
| shell: bash | |
| # MACOS | |
| - name: Install dependencies (MacOS) | |
| if: startsWith(matrix.os, 'macos') | |
| run: | | |
| brew install boost openssl rapidjson p7zip create-dmg cmake tree | |
| shell: bash | |
| - name: Build (MacOS) | |
| if: startsWith(matrix.os, 'macos') | |
| run: | | |
| mkdir build | |
| cd build | |
| cmake \ | |
| -DCMAKE_BUILD_TYPE=Release \ | |
| -DCMAKE_OSX_DEPLOYMENT_TARGET=10.15 \ | |
| -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl \ | |
| -DUSE_PRECOMPILED_HEADERS=OFF \ | |
| -DCHATTERINO_LTO="$C2_ENABLE_LTO" \ | |
| -DCHATTERINO_PLUGINS="$C2_PLUGINS" \ | |
| -DBUILD_WITH_QT6="$C2_BUILD_WITH_QT6" \ | |
| .. | |
| make -j"$(sysctl -n hw.logicalcpu)" | |
| shell: bash | |
| - name: Package (MacOS) | |
| if: startsWith(matrix.os, 'macos') | |
| env: | |
| OUTPUT_DMG_PATH: chatterino-macos-Qt-${{ matrix.qt-version}}.dmg | |
| run: | | |
| ls -la | |
| pwd | |
| ls -la build || true | |
| cd build | |
| ./../.CI/MacDeploy.sh | |
| ./../.CI/CreateDMG.sh | |
| shell: bash | |
| - name: Upload artifact (MacOS) | |
| if: startsWith(matrix.os, 'macos') | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: chatterino-macos-Qt-${{ matrix.qt-version }}.dmg | |
| path: build/chatterino-macos-Qt-${{ matrix.qt-version }}.dmg | |
| create-release: | |
| needs: [build-ubuntu-docker, build] | |
| runs-on: ubuntu-latest | |
| if: (github.event_name == 'push' && github.ref == 'refs/heads/master') | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # allows for tags access | |
| # Windows | |
| - uses: actions/download-artifact@v4 | |
| name: Windows Qt6.5.0 | |
| with: | |
| name: chatterino-windows-x86-64-Qt-6.5.0.zip | |
| path: release-artifacts/ | |
| - uses: actions/download-artifact@v4 | |
| name: Windows Qt6.5.0 symbols | |
| with: | |
| name: chatterino-windows-x86-64-Qt-6.5.0-symbols.pdb.7z | |
| path: release-artifacts/ | |
| - uses: actions/download-artifact@v4 | |
| name: Windows Qt5.15.2 | |
| with: | |
| name: chatterino-windows-x86-64-Qt-5.15.2.zip | |
| path: release-artifacts/ | |
| # Linux | |
| - uses: actions/download-artifact@v4 | |
| name: Linux AppImage | |
| with: | |
| name: Chatterino-x86_64-Qt-6.6.1.AppImage | |
| path: release-artifacts/ | |
| - uses: actions/download-artifact@v4 | |
| name: Ubuntu 20.04 deb | |
| with: | |
| name: Chatterino-ubuntu-20.04-Qt-6.6.1.deb | |
| path: release-artifacts/ | |
| - uses: actions/download-artifact@v4 | |
| name: Ubuntu 22.04 deb | |
| with: | |
| name: Chatterino-ubuntu-22.04-Qt-6.6.1.deb | |
| path: release-artifacts/ | |
| - name: Copy flatpakref | |
| run: | | |
| cp .CI/chatterino-nightly.flatpakref release-artifacts/ | |
| shell: bash | |
| # macOS | |
| - uses: actions/download-artifact@v4 | |
| name: macOS x86_64 Qt5.15.2 dmg | |
| with: | |
| name: chatterino-macos-Qt-5.15.2.dmg | |
| path: release-artifacts/ | |
| - name: Rename artifacts | |
| run: | | |
| ls -l | |
| # Rename the macos build to indicate that it's for macOS 10.15 users | |
| mv chatterino-macos-Qt-5.15.2.dmg Chatterino-macOS-10.15.dmg | |
| # Mark all Windows Qt5 builds as old | |
| mv chatterino-windows-x86-64-Qt-5.15.2.zip chatterino-windows-old-x86-64-Qt-5.15.2.zip | |
| working-directory: release-artifacts | |
| shell: bash | |
| - name: Create release | |
| uses: ncipollo/[email protected] | |
| with: | |
| replacesArtifacts: true | |
| allowUpdates: true | |
| artifactErrorsFailBuild: true | |
| artifacts: "release-artifacts/*" | |
| body: ${{ github.event.head_commit.message }} | |
| prerelease: true | |
| name: Nightly Release | |
| tag: nightly-build | |
| - name: Update nightly-build tag | |
| run: | | |
| git tag -f nightly-build | |
| git push -f origin nightly-build | |
| shell: bash |