QT C++工程CI环境笔记

最新推荐文章于 2024-06-28 11:19:09 发布
最新推荐文章于 2024-06-28 11:19:09 发布
阅读量338 收藏
点赞数
分类专栏： C/C++/ASM 文章标签： java linux docker git ubuntu
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/michaelchain/article/details/119628583
版权

开发环境

  • Ubuntu18.04 or Ubuntu20.04
  • Qt Creator 4.6.x (Based on Qt 5.11.x)
  • APT list: apt-transport-https git dh-make build-essential autoconf autotools-dev qt5-default libssl-dev qt5keychain-dev devscripts

项目结构

项目主体结构是根据Qt, 用.pro文件组织, 项目最外层TEMPLATE用subdirs, 用于引入项目主pro文件, 这样便于将源代码放入子目录, 实际的项目pro文件在子目录下. 最外层还有对应的说明文件, 授权文件和Gitlab CI配置等.

├── .git 
├── .gitignore 
├── .gitlab-ci.yml # Gitlab CI配置文件
├── LICENSE 
├── README.md # 项目Readme
├── rockbb # 实际源代码目录
│   ├── app-entry # 为debian/ubuntu提供的桌面图标配置文件及图标文件
│   │   ├── rockbb.desktop
│   │   └── rockbb.png
│   ├── *.cpp
│   ├── *.h, *.ui
│   ├── config.h                 # 全局配置, namespace rockbb
│   ├── debian                   # deb打包时需要的文件
│   │   ├── changelog         # 软件历史版本信息, 有格式要求
│   │   ├── compat             # debhelper压缩级别, 最新的是10, 如果要兼容可以用9
│   │   ├── control              # 软件的包名, 维护者, 编译工具依赖, 安装依赖等
│   │   ├── copyright           # 标准版权信息, 例如GPLv3
│   │   └── rules                  # 编译和打包命令, 在这里将资源文件复制到deb包的标准位置
│   ├── res.qrc                    # 资源文件, 在这个文件里记录images目录里的各个文件
│   ├── images
│   │   ├── rockbb-off.png
│   │   ├── rockbb-on.png
│   │   ├── rockbb.png
│   ├── main.cpp                # 程序入口
│   └── rockbb.pro              # 主要项目文件
├── rockbb-project.pro        # 项目入口文件(用于引入rockbb.pro)
└── rockbb-project.pro.user # Qt Creator产生的本地开发配置文件, 需要从gitignore中排除

Qt对非Qt项目文件的支持不好, 在project视图下默认不展示不相关的文件, 如果要显示, 需要在.pro文件中使用 OTHER_FILES 将需要显示在工作区的文件包含进来.
如果切换到File System视图, 默认不显示点开头的隐藏文件, 需要在模块右上角选项中勾上"Show Hidden Files", 才会展示.gitlab-ci.yml这些文件.

开发编译和测试

在本地通过Qt Creator完成, 编译, Debug和运行有Ctrl+B, F5, Ctrl+R等快捷方式.

项目文件中常用的变量及说明

  • QT
    指定项目用到的Qt模块, 在编译阶段, 被指定的Qt模块头文件会被include并且被链接. 默认Qt会包含core和gui, 如果项目不需要gui, 需要用 QT -= gui 显式排除.
  • QTPLUGIN
    指定需要链接到最终可执行文件的静态Qt插件, 成为内建资源.
  • CONFIG
    在这里设置项目编译选项, 不同的值对应qmake内部不同的处理, 常用值包括 release, debug, debug_and_release, warn_on, warn_off, c99, c11, c++11, static等
  • DEFINES
    qmake adds the values of this variable as compiler C preprocessor macros (-D option).
  • DESTDIR
    指定最终生成的可执行文件的路径.
  • OBJECTS_DIR
    指定存放编译过程中中间对象的存放路径
  • MOC_DIR
    Specifies the directory where all intermediate moc files should be placed.
  • RCC_DIR
    Specifies the directory for Qt Resource Compiler output files.
  • LIBS
    指定需要被链接到项目的库. 如果使用Unix形式的 -l(library) 和 -L (library path) 参数, qmake 可以在Windows下正确识别处理.
  • QMAKE_CXXFLAGS
    Specifies the C++ compiler flags for building a project. The value of this variable is typically handled by qmake or qmake.conf and rarely needs to be modified. The flags specific to debug and release modes can be adjusted by modifying the QMAKE_CXXFLAGS_DEBUG and QMAKE_CXXFLAGS_RELEASE variables, respectively.
  • SOURCES
    Specifies the names of all source files in the project
  • HEADERS
    Defines the header files for the project.
  • PWD
    解析为包含被解析的当前文件的完整路径. This can be useful to refer to files within the source tree when writing project files to support shadow builds.
  • INCLUDEPATH
    指定编译时 #include 应该查找的目录, 如果目录带空格, 需要用双引号包围.
  • TARGET
    指定最后生成的可执行文件名. 默认等于项目文件名.

项目文件中的语法

变量赋值方式

VAR = foobar => 在qmake执行的时候给VAR变量赋值(值为foobar)
$$VAR   => 在qmake执行的时候, 使用VAR对应的QMake变量值, 例如$$PWD
$${VAR} => 和上面一样只不过将变量显式指出
$(VAR)  => 在Makefile运行时取环境变量的值
$$(VAR) => 在qmake运行时取环境变量的值

包含第三方项目的pri文件

include(path/to/some.pri)

区分debug和release做不同配置

debug: {
    ...
}
release: {
    ...
}

代码仓库

在本地通过 git remote add 将github添加为上游仓库, 这样项目对应的就有 origin 和 github 两个上游, 在本地编译通过后, push origin master可以触发测试环境的gitlab进行集成, 在gitlab测试通过后, 可以push gitlab master将代码提交到github.

测试集成

测试环境的持续集成, 使用Gitlab + Gitlab Runner实现. 有条件的话Gitlab Runner应当跑在独立的服务器上, 另外如果需要构建异构系统例如Windows, OSX等, 都需要将Runner跑在独立的服务器上. 如果只需要构建Linux下的发行版, 可以放在一起. Gitlab Runner需要Docker环境, 最好使用Ubuntu较新的发行版.
gitlab 12.10.6, gitlab-runner 12.10.2, docker 19.03.6

Gitlab配置

略. 这里主要是创建group, project, user, 获取group下的runner token

Gitlab Runner配置

准备Docker镜像, 对于不同的发行版发布, 要准备对应的发行版镜像, 再将这些镜像作为Runner, 注册到Gitlab. 举例Ubuntu18.04的Dockerfile

from ubuntu:bionic
ADD setup.sh /opt/
RUN /bin/bash /opt/setup.sh

和setup.sh, 这个脚本用于切换到较快的apt源, 以及准备编译环境.

#!/bin/sh
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic main restricted" > /etc/apt/sources.list
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic-updates main restricted" >> /etc/apt/sources.list
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic universe" >> /etc/apt/sources.list
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic-updates universe" >> /etc/apt/sources.list
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic multiverse" >> /etc/apt/sources.list
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic-updates multiverse" >> /etc/apt/sources.list
echo "deb http://mirrors.ustc.edu.cn/ubuntu/ bionic-backports main restricted universe multiverse" >> /etc/apt/sources.list
echo "deb http://security.ubuntu.com/ubuntu bionic-security main restricted" >> /etc/apt/sources.list
echo "deb http://security.ubuntu.com/ubuntu bionic-security universe" >> /etc/apt/sources.list
echo "deb http://security.ubuntu.com/ubuntu bionic-security multiverse" >> /etc/apt/sources.list
#requirements
apt-get update
apt-get -y install apt-transport-https git dh-make build-essential autoconf autotools-dev qt5-default libssl-dev qt5keychain-dev devscripts

对于Ubuntu20.04, 在apt install 过程中会出现tzdata等需要交互的安装导致镜像制作失败, 需要在apt-get update前加上这句

export DEBIAN_FRONTEND=noninteractive

制作镜像, 将镜像注册为Runner

# 制作镜像
docker build -t ubuntu_focal_runner:1.0 ubuntu_focal/
# 注册到gitlab
gitlab-runner register --non-interactive --url "http://172.17.54.139/" --registration-token "x7sx4rte_acSXrmznJBz" --description "Ubuntu 20.04 x64 runner" --executor "docker" --docker-image "ubuntu_focal_runner:1.0" --tag-list "ubuntu-2004-64" --run-untagged="false" --locked="false" --access-level="not_protected"

测试镜像是否可用:
对于刚建好的容器镜像, 需要在跑任务前实际执行一下构建, 可以通过 docker run -it --rm [image] bash 的方式, 在命令行下手动git clone项目文件, 执行编译. 如果有问题, 需要在这一步重新制作镜像来解决. 不同的发行版, gcc/g++版本可能会不一样, Ubuntu16.04(GCC 5.4), Ubuntu18.04(GCC 7.5), Ubuntu20.04(GCC9.3), Debian8&10(GCC 8.3)
对于runner, 需要注意的有两点:

  1. 每个runner需要带一个 --tag-list "ubuntu-2004-64" 参数, 里面可以配一个或多个tag, 这个tag-list 结合 .gitlab-ci.yml文件里的 tags 参数, 可以让发行版各自执行对应的任务.
  2. 如果希望Runner就近pull镜像, 在注册完runner后, 需要修改 /etc/gitlab-runner/config.toml 文件, 在每个runner的[runners.docker]配置下, 增加一行配置. 默认为"always", 会主动去docker hub 拉取, 因为自建的镜像只存在本地, 从而导致任务失败.
volumes = ["/cache"]
    pull_policy = "if-not-present"  # 增加这行
    shm_size = 0

项目 .gitlab-ci.yml 配置

参考https://docs.gitlab.com/ee/ci/quick_start/https://docs.gitlab.com/ee/ci/yaml/
根据.gitlab-ci.yml里的任务配置, gitlab在收到新的push后, 会触发产生pipeline, 里面是满足条件的, 分配到对应runner的job. 如果中途有job失败, 整个pipeline就会失败, 不再往下执行.

Github发布

对于版本间一个完整的开发周期, 以上一个版本号Tag提交为开始, 以下一个版本号提交为结束.

开发阶段

假设已经发布的版本号为1.1, 进入当前开发周期后, 首先修改以下文件

  • config.h: 版本号修改为 1.2-dev
    因为测试集成产生的版本号为特殊版本号, 并且会完全覆盖debian/changelog, 故这一阶段还不需要修改changelog

预发布阶段

在测试结束后, 进入发布准备工作, 需要修改以下文件

  • config.h: 版本号修改为 1.2
  • debian/changelog: 加入自上个版本至今的改动说明

对commit ID打tag, 并生成正式版的release

# 加tag
git tag -a 0.1.0 94ca32cbc4bd685774f22d95c66d58c79dccf95f
# 触发测试执行任务, 打包正式版
push origin --tags

本地对release进行测试

发布阶段

将tag推送到github

git push github --tags

之后, github会自动对新tag产生release, 可以手工在此release下添加文字和对应的release软件包

IOsetting
关注
专栏目录
C/C++开发人员要了解的几大著名C/C++开源库
dvlinker的技术专栏
07-24 1万+
本文详细讲述C/C++开发人员需要了解的几大著名C/C++开源库。
【学习笔记】QT/C++/Python软件编程全记录
野生C++程序员
09-26 3082
记录自己开发QT软件的过程及遇到的坑。
C++高级编程（65）持续集成（CI）与自动化构建
m0_51768024的博客
03-17 363
通过本篇博客的学习，我们应该能够理解持续集成和自动化构建的重要性，以及如何在C++项目中实现它们。CI和自动化构建不仅提高了代码质量，还加快了开发周期，使得团队能够更加高效地协作。在实际编程中，我们需要根据具体的需求和场景来选择最合适的工具和技术。随着技术的发展，我们期待有更多先进的工具和方法论来帮助我们更好地进行软件开发。如果您有任何疑问或想要进一步讨论，请随时在评论区留言。让我们继续探索C++的奥秘，共同提高我们的编程技能！
Modern C++ CI
skykingf的专栏
12-05 1267
原文 https://juan-medina.com/2017/07/01/moderncppci/ C++ is more active than ever, with the C++17 standard ready, a widely support on C++14 from major compilers and C++20 planning on the
qt 5.9配置环境
最新发布
m0_45674856的博客
06-28 337
qt 的安装 使用过程
Tars-C++服务的CI/CD
evilstar2015的专栏
04-25 2880
本文演示了通过Jenkins的参数化构建，利用已知的接口和工具，实现Tars-C++服务的持续集成和持续发布。希望对Tars开发者有所帮助。
CIC++快速入门
paranoid的博客
06-04 765
第2章CIC++快速入门 考虑到一些参加考研机试或其他算法考试的读者并没有学过C语言或者C++, 而在机考 中最适合使用的就是这两个语言， 因此编写了CIC++入门的部分。该部分旨在让没有接触过 C语言的读者能够快速上手编写C程序， 因此对一些不影响实际编程的语法点采取了舍去的 策略。如果读者备考的时间比较短且又没有学习过C语言， 那么建议只要把本书提到的语法 点掌握即可；如果读者想要系统、完整地...
qtci:收集脚本以在命令行环境中构建Qt应用程序
05-01
QT-CI 该项目收集了一组脚本，用于在命令行环境中为Android / iOS构建Qt应用程序。 检查以了解其工作原理。 它将演示如何使用QT-CI脚本构建apk文件。 安装 由于此项目是脚本的集合，因此bin文件夹中的脚本彼此之间没有任何依赖关系。 不必将整个存储库克隆/下载到您的构建环境中。 您可以简单地从此存储库中复制所需的脚本。 食谱/安装-qt 要自动安装Qt，您只需下载2个脚本并授予它们执行权限。 “食谱/安装qt”“ bin /提取qt安装程序” 然后只需使用所需版本的Qt示例运行脚本“ recipes / install-qt”： bash install-qt 5.9.4 环境变量 QT_CI_PACKAGES-要安装的软件包。 如果将VERBOSE设置为1，则可以检查可用的软件包。 例子： export VERBOSE=1 export QT_CI_
千锋C++笔记.zip
08-18
《千锋C++笔记》是一份综合性的学习资料，涵盖了C++编程语言的基础到高级概念。这份笔记由知名教育机构“千锋”提供，旨在帮助初学者和有一定基础的程序员深入理解和掌握C++这一强大的系统级编程语言。下面将详细...
Qt 快速入门学习笔记
WJ的博客
05-04 3742
1、windows安装msvc编译器模块需要安装Windows软件开发工具包。MinGW是Windows平台使用GNU工具导入库的集合。2、Linux环境安装双击.run文件即可安装常用的开发依赖3、visual studio中创建Qt项目以及配置1、工具安装a、工具->扩展和更新->联机右上角搜索qt,下载安装Qt Visual Studio Toolsb、配置Qt编译器版本：1、点击Qt VS Tools选项 -> Qt Versions, 再弹出的框中添加对应的编译器版本。
达内c++课程笔记
11-02
【达内C++课程笔记】是一份全面涵盖了C++编程语言...通过这份综合性的课程笔记，学习者能够系统地学习C++编程，同时对相关工具和技术如Oracle数据库、MFC和Qt框架有所了解，有助于全面发展成为一位合格的C++开发者。
Qt gitlab-ci的配置和运行
zsy05131068的博客
05-23 2070
持续集成CI包括以下几个部分         1.代码程序          2.gitlab-ci         3 gitlab-runner      若有在程序中使用ruuner，需要编写.git-ci.yml文件     build_job:   stage: build   script:   - chcp 65001   - echo %PATH%   - ca
使用gitlab 的 CI/CD 功能实现自动编译打包发布Qt win桌面程序的详细教程
打不死的小五
08-04 294
cicd 自动构建打包发布qt程序的详细教程， 还有源码分享，让你少走弯路
vs+qt项目gitlab-ci 配置
此曲只应天上有的博客
06-29 834
gitlab-ci windows版本配置
CI/CD
CSDN博客
06-10 323
最近在求职中，会看到有的公司要求是了解CI/CD，那么这个CI/CD是什么呢？ 通过查找资料后得知就是我们耳熟的持续集成、持续部署等持续动作。 CI全名Continuous Integration，啥意思？就是我们经常听到的持续集成概念。 当开发每天会提交多次代码到主干上，会做一些重复性的动作时，就可以用持续集成环境来操作。 有集成了，就肯定少不了它的好基友，没错就是CD。 CD全名是Continuous Deployment，是持续部署。 CD还有个小号，交持续交付，英文全称是Continuous de
通过Gitlab CI流水线调用脚本启动VS项目编译报错导入Qt文件失败，但是在Gitlab Runner上手动调用脚本就没有报错，可以正常编译。
Prettygod的博客
05-06 233
通过Gitlab CI流水线调用脚本启动VS项目编译报错导入Qt文件失败，但是在Gitlab Runner上手动调用脚本就没有报错，可以正常编译。
【详细文档】基于Qt的跨平台局域网聊天室和群聊文件发送，并使用 Qtest、CI/CD 完成自动测试及自动打包发布
weixin_44473210的博客
11-05 1805
通过 Qt 实现了跨平台的群聊、文件传输功能。包含详细设计文档、测试、CI/CD、代码
QT creator使用（二）：Qt项目建立、编译、运行、发布及移植
热门推荐
qq_41694024的博客
07-04 1万+
简单介绍QT项目的建立、编译、运行、发布及移植
使用Eclipse+Qt+C/C++配置GUI开发环境
"这篇教程介绍了如何在Eclipse环境中利用C/C++和Qt进行GUI界面开发。首先，你需要下载并安装Eclipse C/C++ Developers版本、MinGW编译器、Qt开源版以及Qt Eclipse Integration插件。在安装过程中，确保正确指定...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值