README

此 PHP 库简化了 TeamCity 服务消息的格式化和编写。

安装

要将 TeamcityMessages 添加到您的项目作为本地、按项目依赖项，只需在项目中的 composer.json 文件中添加对 michal-kocarek/teamcity-messages 的依赖即可。以下是一个仅定义 TeamcityMessages 依赖项的 composer.json 文件的示例

{
    "require": {
        "michal-kocarek/teamcity-messages": "^1.2"
    }
}

使用方法

这里是一个基本示例。MessageLogger 实例通过写入器输出所有内容。

StdOutWriter 直接将输出回显到脚本的标凈输出。 （您可以使用 CallbackWriter 将消息传递到任意回调。）

类似这样的代码

use MichalKocarek\TeamcityMessages\MessageLogger;
use MichalKocarek\TeamcityMessages\Writers\StdoutWriter;

$logger = new MessageLogger(new StdoutWriter());

$logger->progressMessage('Reticulating splines...');

$logger->block('Counting llamas...', null, function(MessageLogger $logger) {
    $logger->logWarning('Too many llamas!');
    $logger->publishArtifacts('logs/llamas-count.csv');
});

生成以下输出

##teamcity[progressMessage timestamp='2016-03-16T23:29:37.120555+0000' message='Reticulating splines...']
##teamcity[blockOpened timestamp='2016-03-16T23:29:37.134303+0000' name='Counting llamas...']
##teamcity[message timestamp='2016-03-16T23:29:37.134535+0000' text='Too many llamas!' status='WARNING']
##teamcity[publishArtifacts timestamp='2016-03-16T23:29:37.134635+0000' path='logs/llamas-count.csv']
##teamcity[blockClosed timestamp='2016-03-16T23:29:37.134993+0000' name='Counting llamas...']

有关使用方法和详细信息，请参阅 MessageLogger 的公共方法，以下链接提供详细的消息规范。

链接

• 与 TeamCity 的构建脚本交互

作者

Michal Kočárek michal.kocarek@brainbox.cz - https://twitter.com/michalkocarek

许可证

此库采用 MIT 许可证授权 - 有关详细信息，请参阅 LICENSE 文件。