通过Commit SHA1获取Build状态

时间:2015-07-01 14:42:26

标签: rest tfs continuous-integration teamcity tfs2015

我们的团队正在使用TeamCity进行持续集成,使用Git-TFS(TFS2015 RC)进行版本控制。

我想检查TeamCity是否已成功构建特定的Commit,从而可以重新集成。

可以使用REST API查询TeamCity构建,例如:

GET http://teamcity:8000/guestAuth/app/rest/builds/18

结果包含一些显示git commit SHA的xml:

<revisions count="1">
    <revision version="96b1db05b64ecc895da070137e93cde3d2cadfa1">
        <vcs-root-instance [...]/>
    </revision>
</revisions>

事实上,这些信息在理论上是可用的,这使我希望可以通过这些特定信息查询TeamCity构建,例如:

GET http://teamcity:8000/guestAuth/app/rest/builds/revision:96b1db05b64ecc895da[...]

但这会产生#400 BAD REQUEST 响应。我无法在TeamCity 9 Documentation中找到这是否可能。我宁愿不迭代所有构建以检查它们是否包含此特定提交。

注意:此功能现已由JetBrains实施,现在可在TeamCity 9.1 EAP4中使用。

5 个答案:

答案 0 :(得分:1)

我不相信这可以在没有迭代的情况下完成,这有点烦人

您可以按哈希查看更改

/httpAuth/app/rest/changes?version:SHA_HASH

您可以通过构建定位器找到更改

/httpAuth/app/rest/changes?locator=build:(id:BUILD_ID)

但你不能走另一条路,否则这可以简单地完成。

buildLocator不允许您使用修订维度进行查询,因此我无法查看此方法

如果您还没有自己编写以下脚本,可能会对您有用 - 将其保存到名为get-build-status-by-git-commit.ps1的文件中,以便最后使用该示例

# -----------------------------------------------
# Get Build Status By Git Commit
# -----------------------------------------------
#
# Ver   Who         When      What
# 1.0   DevOpsGuys  01-07-15  Initial Version

# Script Input Parameters
param (
    [ValidateNotNullOrEmpty()]
    [string] $TeamCityServer = $(throw "-TeamCityServer is mandatory, please provide a value."),
    [ValidateNotNullOrEmpty()]
    [string] $ApiUsername = $(throw "-ApiUsername is mandatory, please provide a value."),
    [ValidateNotNullOrEmpty()]
    [string] $ApiPassword = $(throw "-ApiPassword is mandatory, please provide a value."),
    [ValidateNotNullOrEmpty()]
    [string] $GitSha = $(throw "-GitSha is mandatory, please provide a value.")
)

function Main() 
{
    $CurrentScriptVersion = "1.0"
    $ApiCredentials = New-Object System.Management.Automation.PSCredential($ApiUsername, (ConvertTo-SecureString $ApiPassword -AsPlainText -Force))

    Write-Host "================== Get Build Status By Git Commit - Version"$CurrentScriptVersion": START =================="

    # Log input variables passed in
    Log-Variables
    Write-Host

    # Set initial query url
    $queryBuilds = "/httpAuth/app/rest/builds?fields=nextHref,build(id,status,revisions)"

    while($queryBuilds)
    {
        $buildsToCheck = Api-Get "$TeamCityServer$queryBuilds"
        $queryBuilds = $buildsToCheck.builds.nextHref;
        foreach($build in $buildsToCheck.builds.build)
        {
            if ($build.revisions.revision.version -eq $GitSha) {
                Write-Host "STATUS: "$build.status
                Exit 0
            }
        }
    }

    Write-Host "================== Get Build Status By Git Commit - Version"$CurrentScriptVersion": END =================="
}

function Log-Variables
{
    Write-Host "TeamCityServer: " $TeamCityServer
    Write-Host "GitSha: " $GitSha
    Write-Host "Computername:" (gc env:computername)
}

function Api-Get($Url)
{
    Write-Host $Url
    return Invoke-RestMethod -Credential $ApiCredentials -Uri $Url -Method Get -TimeoutSec 20;
}

Main

您可以通过以下方式使用此功能

.\get-build-status-by-git-commit.ps1 "http://teamcity:8000/" username password 96b1db05b64ecc895da070137e93cde3d2cadfa1

这是使用httpAuth,但您可以轻松地定制脚本以使用guest。我已经使用过httpAuth,以防其他人使用它。

希望这有帮助

答案 1 :(得分:1)

我正在寻找同样的事情并偶然发现了这个问题。我不知道你是否仍然需要这个但是我在TeamCity v10中找到了API。但您必须知道此

BuildTypeID
    https://${teamcity.domain}/app/rest/buildTypes/id:${BuildTypeID}/builds/revision:${COMMIT_SHA}

您可以通过转到特定版本然后

从TeamCity UI中找到您的构建类型ID
    Edit configuration settings >> General Settings

然后是构建配置ID 字段中的值。

希望这有帮助。

答案 2 :(得分:0)

TeamCity问题跟踪器中的相关功能请求:https://youtrack.jetbrains.com/issue/TW-40540。为它投票。 当前的解决方法是请求构建及其修订包含在响应中,然后在客户端找到必要的构建。 请求可能如下所示:

... /应用程序/静止/构建定位= buildType(ID:XXX)及字段=构建(ID,HREF,修订(修订版))

答案 3 :(得分:0)

teamcity的最新版本允许使用“版本”定位器,以便以下版本将返回SHA匹配查询的版本。

http://teamcity:8111/app/rest/changes?locator=version:SHA_HASH

答案 4 :(得分:0)

我在TeamCity 2019.2上,并且能够直接在builds端点上搜索特定的提交:

TEAMCITY_URL/app/rest/builds/revision:SHA_HASH

不确定实施的版本。