Installing Qt on Github Actions workflows manually is the worst.
You know what's easier than dealing with that? Just using this:
- name: Install Qt
uses: jurplel/install-qt-action@v2All done.
The desired version of Qt to install.
Default: 5.15.2 (Latest LTS at the time of writing)
Please note that for Linux builds, Qt 6+ requires Ubuntu 20.04 or later.
This is the host platform of the Qt version you will be installing. It's unlikely that you will need to set this manually if you are just building.
For example, if you are building on Linux and targeting desktop, you would set host to linux. If you are building on Linux and targeting android, you would set host to linux also. The host platform is the platform that your application will build on, not its target platform.
Possible values: windows, mac, or linux
Defaults to the current platform it is being run on.
This is the target platform that you will be building for. You will want to set this if you are building for iOS or Android.
Please note that iOS builds are supported only on macOS hosts
Possible values: desktop, android, or ios
Default: desktop
This is the target architecture that your program will be built for. This is only used for Windows and Android.
Linux x86 packages are not supported by this action. Qt does not offer pre-built Linux x86 packages. Please consider using your distro's repository or building it manually.
Possible values:
Windows: win64_msvc2019_64, win64_msvc2017_64, win64_msvc2015_64, win32_msvc2015, win32_mingw53, win64_mingw73 or win64_mingw81
Android: android_x86, android_armv7
You can find a full list of architectures by checking the Updates.xml for your version/platform. For Qt 5.12.9 on windows: https://download.qt.io/online/qtsdkrepository/windows_x86/desktop/qt5_5129/Updates.xml
Default values:
Windows w/ Qt < 5.6: win64_msvc2013_64
Windows w/ Qt >= 5.6 && Qt < 5.9: win64_msvc2015_64
Windows w/ Qt >= 5.9 && Qt < 5.15: win64_msvc2017_64
Windows w/ Qt >= 5.15: win64_msvc2019_64
Android: android_armv7
This is the directory prefix that Qt will be installed to.
For example, if you set dir to ${{ github.workspace }}/example/, your bin folder will be located at $GITHUB_WORKSPACE/example/Qt/5.12.9/(your_arch)/bin. When possible, access your Qt directory through the Qt5_DIR or Qt6_DIR environment variable.
Default: $RUNNER_WORKSPACE (this is one folder above the starting directory)
Whether or not to automatically install Qt dependencies on Linux (you probably want to leave this on).
Can be set to nosudo to stop it from using sudo, for example on a docker container where the user already has sufficient privileges.
Default: true
String with whitespace delimited list of additional addon modules to install, with each entry seperated by a space. If you need one of these, you'll know it.
Possible values: qtcharts, qtdatavis3d, qtpurchasing, qtvirtualkeyboard, qtwebengine, qtnetworkauth, qtwebglplugin, qtscript, debug_info, possibly others
Default: none
String with whitespace delimited list of Qt archives to install, with each entry seperated by a space. Typically you don't need this unless you are aiming for bare minimum installation.
Example values: qtbase, qtsvg, qtdeclarative, qtgamepad, qtgraphicaleffects, qtimageformats, qtlocation, possibly others
Default: none
If it is set to true, then Qt won't be downloaded, but the environment variables will be set, and essential build tools will be installed.
It can be used with actions/cache@v1, for example:
- name: Cache Qt
id: cache-qt
uses: actions/cache@v1 # not v2!
with:
path: ../Qt
key: ${{ runner.os }}-QtCache
- name: Install Qt
uses: jurplel/install-qt-action@v2
with:
cached: ${{ steps.cache-qt.outputs.cache-hit }}
Default: false
Set this to false if you want to skip using setup-python to find/download a valid python version. If you are on a self-hosted runner, you will probably need to set this to false because setup-python requires a very specific environment to work.
Default: true
Qt "tools" to be installed. I would recommend looking at aqtinstall's instructions for this, as it is an experimental feature. Specify the tool name and tool variant name separated by commas, and separate multiple tools with spaces. If you wish to install all tools available for a given tool name, you can leave off the tool variant name.
For example, this value will install the most recent versions of QtIFW and QtCreator:
tools: 'tools_ifw tools_qtcreator,qt.tools.qtcreator'
Set this to false if you want to avoid setting environment variables for whatever reason.
Default: true
Set this to true if you only want to install tools, and not Qt.
Default: false
Version of aqtinstall to use, given in the format used by pip, for example: ==0.7.1, >=0.7.1, ==0.7.*. This is intended to be used to troubleshoot any bugs that might be caused or fixed by certain versions of aqtinstall.
Default: ==2.0.0
Version of py7zr in the same style as the aqtversion and intended to be used for the same purpose.
Default: ==0.16.1
This input can be used to append arguments to the end of the aqtinstall command for any special purpose.
Example value: --external 7z
- name: Install Qt
uses: jurplel/install-qt-action@v2
with:
version: '5.15.2'
host: 'windows'
target: 'desktop'
arch: 'win64_msvc2019_64'
dir: '${{ github.workspace }}/example/'
install-deps: 'true'
modules: 'qtcharts qtwebengine'
cached: 'false'
setup-python: 'true'
tools: 'tools_ifw tools_qtcreator,qt.tools.qtcreator'
set-env: 'false'
tools-only: 'false'
aqtversion: '==2.0.0'
py7zrversion: '==0.16.1'
extra: '--external 7z'The Qt bin directory is appended to your path environment variable. Qt5_DIR/Qt6_DIR is also set appropriately for cmake.
In addition, QT_PLUGIN_PATH, QML2_IMPORT_PATH, PKG_CONFIG_PATH and LD_LIBRARY_PATH are set accordingly. IQTA_TOOLS is set to the "Tools" directory if tools are installed as wlel.
Big thanks to the aqtinstall developer for making this easy. Please go support miurahr, he did all of the hard work here (his liberapay).
This action is distributed under the MIT license.
By using this action, you agree to the terms of Qt's licensing. See Qt licensing and Licenses used by Qt.