.github/workflows/main.yml

   1 # Workflow that builds Quassel on various Linux distros, and creates packages for both Windows and macOS.
   2 # For tagged pushes, a draft release is automatically created, using the tag message as release description
   3 # and attaching Windows and macOS builds, as well as the source archive.
   4 name: Quassel CI
   5
   6 on: [ push, pull_request ]
   7
   8 defaults:
   9   run:
  10     shell: bash
  11
  12 jobs:
  13
  14 # ------------------------------------------------------------------------------------------------------------------------------------------
  15   build-linux:
  16     name: Linux
  17     runs-on: ubuntu-latest
  18     container: quassel/quassel-build-env:${{ matrix.dist }}
  19     strategy:
  20       fail-fast: false
  21       matrix:
  22         dist: [ debian-stable, debian-testing, ubuntu-xenial, ubuntu-bionic, ubuntu-focal, ubuntu-groovy ]
  23         cxx: [ 'g++', 'clang++' ]
  24         with-kde: [ -DWITH_KDE=ON ]
  25         extra-options: [ -DWITH_WEBENGINE=ON ]
  26         include:
  27           # Baseline, test more combinations
  28           - dist: ubuntu-xenial
  29             with-kde: -DWITH_KDE=OFF
  30             extra-options: -DWITH_WEBKIT=ON
  31           - dist: ubuntu-xenial
  32             with-kde: -DWITH_KDE=ON
  33             extra-options: -DWITH_WEBKIT=ON
  34         exclude:
  35           # QtWebEngine is not available on Xenial
  36           - dist: ubuntu-xenial
  37             extra-options: -DWITH_WEBENGINE=ON
  38     env:
  39         CCACHE_BASEDIR: ${{ github.workspace }}
  40         CCACHE_DIR: ${{ github.workspace }}/ccache
  41         CCACHE_MAXSIZE: 100M
  42         CXX: ${{ matrix.cxx }}
  43
  44     steps:
  45     - name: Check out source code
  46       uses: actions/checkout@v2
  47
  48     - name: Get timestamp
  49       id: get-timestamp
  50       run: echo "::set-output name=timestamp::$(date -u "+%F-%R")"
  51
  52     - name: Setup ccache
  53       uses: actions/cache@v2
  54       with:
  55         path: ${{ github.workspace }}/ccache
  56         key: ${{ matrix.dist }}-ccache-${{ steps.get-timestamp.outputs.timestamp }}
  57         restore-keys: |
  58              ${{ matrix.dist }}-ccache-
  59
  60     - name: Zero ccache stats
  61       run: ccache -z
  62
  63     - name: Configure
  64       run: |
  65         mkdir build
  66         cd build && cmake $GITHUB_WORKSPACE \
  67                           -GNinja \
  68                           -DCMAKE_BUILD_TYPE=Release \
  69                           -DBUILD_TESTING=ON \
  70                           -DFATAL_WARNINGS=ON \
  71                           ${{ matrix.with-kde }} \
  72                           ${{ matrix.extra-options }}
  73
  74     - name: Build
  75       run: cd build && ninja
  76
  77     - name: Run tests
  78       run: cd build && ctest
  79
  80     - name: Install
  81       run: cd build && DESTDIR=$GITHUB_WORKSPACE/image ninja install
  82
  83     - name: Print ccache stats
  84       run: ccache -s
  85
  86 # ------------------------------------------------------------------------------------------------------------------------------------------
  87   build-macos:
  88     name: macOS
  89     runs-on: macos-latest
  90     env:
  91       CCACHE_BASEDIR: ${{ github.workspace }}
  92       CCACHE_DIR: ${{ github.workspace }}/ccache
  93       CCACHE_MAXSIZE: 100M
  94
  95     steps:
  96     - name: Select Xcode version
  97       uses: maxim-lobanov/setup-xcode@v1
  98       with:
  99         # Newer Xcode versions may not officially be supported by Qt
 100         xcode-version: '10.3'
 101
 102     - name: Check out source code
 103       uses: actions/checkout@v2
 104       with:
 105         fetch-depth: 0  # so git-describe works
 106
 107     - name: Fetch tag information
 108       if: startsWith(github.ref, 'refs/tags/')
 109       run: git fetch -f origin $GITHUB_REF:$GITHUB_REF
 110
 111     - name: Install dependencies
 112       # Skip "brew update" as it can trigger 50+ minutes of updating.
 113       # GitHub Actions intentionally disables the default auto-update on their
 114       # macOS CI images (and macOS CI images usually update once a week).
 115       #
 116       # See https://github.com/actions/virtual-environments/issues/2173
 117       # > We've set no auto-update intentionally here [...]
 118       # And https://github.com/microsoft/appcenter/issues/293
 119       #
 120       # If Homebrew begins failing in the future due to out-of-date versions,
 121       # it can be re-enabled here as follows...
 122       # run: brew update && [below command]
 123       run: brew install boost ccache ninja qca qt5
 124
 125     - name: Get timestamp
 126       id: get-timestamp
 127       run: echo "::set-output name=timestamp::$(date -u "+%F-%R")"
 128
 129     - name: Setup ccache
 130       uses: actions/cache@v2
 131       with:
 132         path: ${{ github.workspace }}/ccache
 133         key: macos-ccache-${{ steps.get-timestamp.outputs.timestamp }}
 134         restore-keys: |
 135              macos-ccache-
 136
 137     - name: Zero ccache stats
 138       run: ccache -z
 139
 140     - name: Configure
 141       run: |
 142         mkdir build
 143         cd build && cmake $GITHUB_WORKSPACE \
 144                           -GNinja \
 145                           -DCMAKE_PREFIX_PATH=/usr/local/opt/qt/lib/cmake \
 146                           -DCMAKE_BUILD_TYPE=Release \
 147                           -DBUILD_TESTING=ON \
 148                           -DFATAL_WARNINGS=OFF \
 149                           -DDEPLOY=ON \
 150                           -DENABLE_SHARED=OFF
 151
 152     - name: Build
 153       run: |
 154         # Deploy scripts require qmake in the path
 155         export PATH=$PATH:/usr/local/opt/qt5/bin
 156         cd build && ninja
 157
 158     - name: Run tests
 159       run: cd build && ctest
 160
 161     - name: Install
 162       run: cd build && DESTDIR=$GITHUB_WORKSPACE/image ninja install
 163
 164     - name: Print ccache stats
 165       run: ccache -s
 166
 167     - name: Upload artifacts
 168       uses: actions/upload-artifact@v2
 169       with:
 170         name: macOS
 171         path: ${{ github.workspace }}/build/*.dmg
 172
 173 # ------------------------------------------------------------------------------------------------------------------------------------------
 174   build-windows:
 175     name: Windows
 176     runs-on: windows-latest
 177     env:
 178       WORKSPACE: ${{ github.workspace }}
 179       CRAFT: /C/CraftMaster/windows-msvc2019_64-cl/craft/bin/craft.py
 180
 181     steps:
 182     - name: Check out source code
 183       uses: actions/checkout@v2
 184       with:
 185         fetch-depth: 0  # so git-describe works
 186
 187     - name: Fetch tag information
 188       if: startsWith(github.ref, 'refs/tags/')
 189       run: git fetch -f origin $GITHUB_REF:$GITHUB_REF
 190
 191     - name: Clone CraftMaster
 192       run: git clone --depth=1 https://invent.kde.org/kde/craftmaster.git /C/CraftMaster/CraftMaster
 193
 194     - name: Configure CraftMaster
 195       run: python /C/CraftMaster/CraftMaster/CraftMaster.py --config $WORKSPACE/.craftsettings.ini --variables "WORKSPACE=$WORKSPACE"
 196
 197     - name: Add Quassel blueprint
 198       run: python $CRAFT --add-blueprint-repository https://github.com/quassel/craft-blueprints-quassel.git
 199
 200     - name: Install NSIS
 201       run: python $CRAFT dev-utils/nsis
 202
 203     - name: Install dependencies
 204       run: python $CRAFT --install-deps quassel/quassel
 205
 206     - name: Build
 207       run: python $CRAFT --no-cache --src-dir $WORKSPACE quassel/quassel
 208
 209     - name: Run tests
 210       run: python $CRAFT --no-cache --src-dir $WORKSPACE --test quassel/quassel
 211
 212     - name: Package
 213       run: python $CRAFT --no-cache --src-dir $WORKSPACE --package quassel/quassel
 214
 215     - name: Upload artifacts
 216       uses: actions/upload-artifact@v2
 217       with:
 218         name: Windows
 219         path: ${{ github.workspace }}/packages/*
 220
 221 # ------------------------------------------------------------------------------------------------------------------------------------------
 222   post-build:
 223     name: Post-Build
 224     runs-on: ubuntu-latest
 225     needs: [ build-linux, build-macos, build-windows ]
 226     env:
 227       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 228
 229     steps:
 230     - name: Check out source code
 231       uses: actions/checkout@v2
 232
 233     - name: Fetch tag information
 234       if: startsWith(github.ref, 'refs/tags/')
 235       run: git fetch -f origin $GITHUB_REF:$GITHUB_REF
 236
 237     - name: Download artifacts
 238       uses: actions/download-artifact@v2
 239       with:
 240         path: artifacts
 241
 242     - name: List artifacts
 243       run: ls -lhR artifacts
 244
 245     - name: Check artifacts
 246       run: |
 247         # Sanity check: We should have exactly 5 files matching the given patterns
 248         [[ 5 -eq $(find artifacts/ \( -type f -name 'Quassel*.dmg' -o -name 'quassel*.exe' -o -name 'quassel*.7z' \) -printf '.' | wc -c) ]]
 249
 250     - name: Create release notes
 251       if: startsWith(github.ref, 'refs/tags/')
 252       run: |
 253         # Use the tag's annotation as release notes
 254         TAGNAME=$(git rev-parse --abbrev-ref $GITHUB_REF)
 255         MESSAGE=$(git tag -l --format='%(contents)' $TAGNAME | perl -ne 'print if not /-----BEGIN PGP SIGNATURE-----/../-----END PGP SIGNATURE-----/')
 256         echo -e "Quassel $TAGNAME\n\n$MESSAGE" > release_notes.txt
 257
 258     - name: Prepare source archive
 259       if: startsWith(github.ref, 'refs/tags/')
 260       run: |
 261         mkdir assets
 262         TAGNAME=$(git rev-parse --abbrev-ref $GITHUB_REF)
 263         git archive --format=tar --prefix=quassel-$TAGNAME/ $TAGNAME | xz > assets/quassel-$TAGNAME.tar.xz
 264
 265     - name: Prepare packages for release
 266       if: startsWith(github.ref, 'refs/tags/')
 267       run: |
 268         TAGNAME=$(git rev-parse --abbrev-ref $GITHUB_REF)
 269         for type in Client Core Mono; do
 270           mv artifacts/macOS/Quassel$type*.dmg assets/Quassel$type-macOS-$TAGNAME.dmg
 271         done
 272         mv artifacts/Windows/quassel-*.exe assets/quassel-windows-setup-$TAGNAME.exe
 273         mv artifacts/Windows/quassel-*.7z assets/quassel-windows-$TAGNAME.7z
 274
 275     - name: Create checksums for release assets
 276       if: startsWith(github.ref, 'refs/tags/')
 277       run: find assets/ -type f -execdir sh -c 'sha256sum "$1" > "$1.sha256sum"' _ {} \;
 278
 279     - name: Create draft release
 280       if: startsWith(github.ref, 'refs/tags/')
 281       run: |
 282         # The stock upload-release-asset action can only handle single files
 283         # Instead, use the hub utility so we can upload all assets at once
 284         assets=()
 285         for asset in assets/*; do assets+=("-a" "$asset"); done
 286         hub release create -d "${assets[@]}" -F release_notes.txt `git rev-parse --abbrev-ref $GITHUB_REF`