JFrog

    云客户?
    免费开始>
    在MyJFrog >中升级
    云b>的新功能






    跳到元数据的末尾
    转到元数据的开始

    概述

    一个GitRepo用于将JFrog pipeline连接到源代码控制存储库。将它添加到repo中会创建一个webhook，这样以后提交时就会自动创建一个带有webhook有效负载的新版本。


    资源的第一个版本(如果它是在接收任何webhook之前运行的步骤的输入)将用于创建资源时源提供程序上的默认分支中的最新提交。可以限制以后的资源版本 分支机构 ， 标签 , buildOn 选项。

    要抑制单个提交的触发，请包含文本skipRun在提交消息中。

    默认情况下GitRepo资源使用ssh使用已创建的部署键来获取源存储库内容。然而，这只为pipeline提供了对源存储库的只读访问。用户还可以选择配置aGitRepo可供使用的资源https协议。在这种情况下，根据用于设置Git提供程序集成的凭据，pipeline将拥有对源存储库的特权。

    页面内容

    相关内容

    管道快速入门

    YAML模式

    2022世界杯阿根廷预选赛赛程资源:-名称:<字符串>类型:GitRepo配置:gitProvider: 路径:<字符串>文件:包括:<正则表达式>排除:<正则表达式>分支:包括:<正则表达式>排除:<正则表达式> pullRequestSourceBranches:包括:<正则表达式>排除:<正则表达式> pullRequestTargetBranches:包括:<正则表达式>排除:<正则表达式>标签:包括:<正则表达式>排除:<正则表达式> buildOn:commit:  pullRequestCreate:  pullRequestClose:  releaseCreate:  tagCreate:  cancelPendingRunsOn: newCommit:  pullRequestUpdate:  shallowDepth: <正整数> #用于设置repo(浅)克隆/获取的深度cloneProtocol:  #可选。缺省为ssh pin: versionId:  sha:

    标签

    名字

    一个字母数字标识资源的字符串(允许下划线)。

    类型

    必须GitRepo对于此资源类型。

    配置

    指定资源的所有配置选择。


    标签

    描述

    		 必需的/可选

    gitProvider

    		 源代码管理集成的名称。目前支持的集成类型有: 要求
    路径

    从集成根目录到存储库的路径。

    路径可以是硬编码的，也可以使用{{.jfrog-pipelines.sourceRepository}}变量以引用当前管道源路径。

    例子 
    -名称:myfirst strepo类型:GitRepo配置:gitProvider: myGitHub路径:{{.jfrog-pipeline . sourcererepository}}
    		 要求

    文件
    • 包括——(可选)包含符合repo模式的文件的正则表达式
    • 排除——(可选)从repo中排除符合模式的文件的正则表达式
    • 如果未指定此标记，则默认匹配所有文件。
    • 此过滤器仅适用于提交事件，而不适用于拉取请求、标签或发布。
    		 可选

    分支机构
    • 包括——(可选)包含repo分支的正则表达式
    • 排除——(可选)从repo中排除分支的正则表达式

    支持正则表达式

    的分支机构标签支持以下正则表达式:

    ^ $。*&？@ =;：+

    例子：

    ^ gitBranch美元(触发该分支)

    例子。*

    例子+强生的

    +例子:@ = * $

    ^ ._example +:&.@=+;?.*$

    +例子。:@ = *;?1661337986460美元

    如果未指定标记，则触发默认分支。

    		 可选
    pullRequestSourceBranches
    • 包括——(可选)包含来自匹配模式的分支的拉取请求的正则表达式
    • 排除——(可选)排除来自匹配模式的分支的拉取请求的正则表达式

    如果未指定此标记，则默认匹配所有分支。

    		 可选
    pullRequestTargetBranches
    • 包括——(可选)包含对匹配模式的分支的拉取请求的正则表达式
    • 排除——(可选)正则表达式，用于排除对匹配模式的分支的拉取请求

    如果未指定此标记，则分支机构标记设置将应用于目标分支。如果都没有指定，则默认匹配所有分支。

    		 可选
    标签

    用于指定在其上创建新版本的标记和发布的集合

    • 包括——(可选)包含符合repo模式的标签的正则表达式
    • 排除——(可选)从repo中排除符合模式的标签的正则表达式

    如果未指定此标记，则默认匹配所有标记。

    		 可选
    buildOn

    用于控制是否在指定事件时更新资源

    • 提交——(默认为true)用于控制是否为提交webhook更新资源。注意w然后设为假，则没有更新资源，也没有创建资源版本。
    • pullRequestCreate——(默认为false)用于控制是否为pull request webhook更新资源
    • pullRequestClose——(默认为false)用于控制关闭拉取请求webhook时是否更新资源
    • releaseRequestCreate——(默认为false)用于控制资源是否会为发布webhook而更新

    • tagCreate——(默认为false)用于控制是否为标签webhook更新资源

      在多分支管道中，当tagCreate设为真正的当你执行带有特定标记的提交或Git发布时，buildOn.commit只会触发那些带有相关Git标记的分支。

      这只适用于GitHub。

    如果未指定此标签，则提交:真正的是默认设置。

    有关使用此标记的详细信息，请参见触发Git存储库更改．

    		 可选
    cancelPendingRunsOn

    用于控制先前触发的运行是否因新webhook而取消

    • newCommit——(默认为false)取消先前的处理或等待相同分支的提交，相同标签名的标签，相同发布名的版本。
    • pullRequestUpdate——(默认为false)当webhook收到拉取请求时，取消先前的处理或等待运行相同的拉取请求号。

    默认情况下，该标签的所有值都为false。

    有关使用此标记的详细信息，请参见在Git存储库更改时取消先前的运行．

    		 可选
    shallowDepth

    使用一个正整数设置(浅)克隆/获取repo的深度

    如果shallowDepth未指定，则不会将浅克隆选项传递给git。完整的回购被完整地克隆。

    		 可选
    cloneProtocol 用于选择克隆repo时使用的协议。支持的值有ssh或https．默认为ssh． 可选
    销

    此配置可用于将资源固定到特定版本。固定的资源版本将由引用此资源作为输入的步骤使用，较新的版本将被忽略。

    在选择要固定的GitRepo资源版本时，用户有两个配置选项:

    • versionId—资源版本号(可通过UI获取)

    或

    • 沙--提交必须被钉住

    使用资源作为输出的步骤仍然可以生成新版本。对于使用该资源作为输入的步骤，只要它们是创建该版本的步骤的同一运行的一部分，就可以看到新版本。

    当创建一个新的运行时，手动自定义触发器仍然可以用来将固定的版本覆盖到另一个版本。

    		 可选

    使用包括和排除模式

    当两个包括和排除使用模式时，以下规则应用于提交更改列表中的所有文件列表:

    • 不匹配的所有文件包括图案被移除
    • 匹配的所有文件排除图案被移除
    • 如果剩下任何文件，则更新资源

    环境变量

    每当GitRepo，则会自动提供一组可在步骤中使用的环境变量。

    环境变量 描述 
    res_ < resource_name > _path
    		 资源的相对路径 
    res_ < resource_name > _branchName
    		 发生提交的分支的名称。如果它是为拉取请求创建的，则这是基本分支 
    res_ < resource_name > _commitMessage
    		 正在使用的版本的提交消息 
    res_ < resource_name > _commitSha
    		 正在使用的版本提交的SHA 
    res_ < resource_name > _commitUrl
    		 提交的URL 
    res_ < resource_name > _committerLogin
    		 正在使用的SHA的提交者的名称 
    res_ < resource_name > _gitProvider_name
    		 Git集成名称 
    res_ < resource_name > _gitProvider_url
    		 Git提供程序集成的URL 
    res_ < resource_name > _gitRepoFullName
    		 Git仓库的名称 
    res_ < resource_name > _gitRepoRepositoryHttpsUrl
    		 Git存储库的HTTPS URL 
    res_ < resource_name > _gitRepoRepositorySshUrl
    		 Git存储库的SSH URL。 
    res_ < resource_name > _gitRepoRepositoryUrl
    		 Git存储库的URL 
    res_ < resource_name > _gitRepoSourceDefaultBranch
    		 Git存储库的默认分支 
    res_ < resource_name > _gitTagName
    		 如果当前版本中存在标记名，则此为标记名 
    res_ < resource_name > _integrationName
    		 的名字GitRepo使用的集成字符串 
    res_ < resource_name > _isGitTag
    		 真正的如果版本是基于git标签的构建 
    res_ < resource_name > _isPrerelease
    		 真正的如果版本是基于git发布的构建。仅当集成是GitHub时支持 
    res_ < resource_name > _isPullRequest
    		 真正的如果版本是git，则打开基于拉取请求的构建 
    res_ < resource_name > _isPullRequestClose
    		 真正的，如果版本是git关闭的基于拉取请求的步骤。仅当集成为GitHub或Bitbucket或Gitlab时支持。 
    res_ < resource_name > _isRelease
    		 真正的如果版本是基于git发布的构建。仅当集成是GitHub时支持 
    res_ < resource_name > _pullRequestNumber
    		 拉取请求的ID号 
    res_ < resource_name > _pullRequestBaseBranch
    		 将合并pull请求更改的基本分支的名称 
    res_ < resource_name > _pullRequestSourceUrl
    		 拉取请求的源URL 
    res_ < resource_name > _pullRequestSourceHttpsUrl
    		 拉取请求的源HTTPS URL 
    res_ < resource_name > _pullRequestSourceSshUrl
    		 拉取请求的源SSH URL 
    res_ < resource_name > _resourcePath
    		 节点上资源文件夹的完整路径 
    res_ < resource_name > _operation
    		 输入或输出资源 
    res_ < resource_name > _shaData

    JSON对象，其中包含SHA的详细信息

    		 
    res_ < resource_name > _beforeCommitSha
    		 提交之前的SHA 
    res_ < resource_name > _baseCommitRef
    		 PR中基本分支的提交SHA 
    res_ < resource_name > _headCommitRef
    		 PR中源分支的提交SHA 
    res_ < resource_name > _compareUrl
    		 比较提交的URL 
    res_ < resource_name > _gitTagMessage
    		 如果创建了一个git标签，如果它存在，则保存该消息 
    res_ < resource_name > _releaseName
    		 如果创建了一个发布，它将保存发布的名称 
    res_ < resource_name > _releaseBody
    		 如果创建了一个发布，它将保存该发布的描述 
    res_ < resource_name > _releasedAt
    		 如果创建了一个发布，它将保存发布的日期 
    res_ < resource_name > _lastAuthorLogin
    		 最后一个作者登录时间的详细信息 
    res_ < resource_name > _lastAuthorEmail
    		 作者邮箱 
    res_ < resource_name > _isBranchCreate
    		 真正的是否创建了分支 
    res_ < resource_name > _isBranchDelete
    		 真正的分支是否被删除

    例子

    示例1

    GitRepo资源监听主分支 
    2022世界杯阿根廷预选赛赛程资源:-名称:my_app_repo类型:GitRepo配置:gitProvider: my_github路径:myuser/repo-name分支:include: master

    示例2

    GitRepo资源监听所有分支，master和release除外 
    2022世界杯阿根廷预选赛赛程资源:-名称:my_app_repo类型:GitRepo配置:gitProvider: my_github路径:myuser/repo-name分支:exclude: ^(master|release)$

    示例3

    下面的示例可能有助于引用源存储库中的单个目录，该目录包含大型项目中单个微服务的源代码。

    GitRepo资源只监听目录中的某些文件 
    2022世界杯阿根廷预选赛赛程资源:-名称:my_app_repo类型:GitRepo配置:gitProvider: my_github路径:myuser/repo-name branches: include:主文件:include: ^folder1\/package\/docker\/micro1\/.+

    示例4

    默认情况下，GitRepo在提交时触发，但这可以在buildOn属性。有关触发的详细信息，请参见触发管道和步骤．

    GitRepo只触发pull请求而不触发commit 
    2022世界杯阿根廷预选赛赛程资源:-名称:my_app_repo类型:GitRepo配置:gitProvider: my_github路径:myuser/repo-name分支:include: master buildOn: commit: false pullRequestCreate: true

    示例5

    下面的示例管道在GitRepo资源上触发第一步。该步骤使用GitRepo资源公开的环境变量导航到构建节点上克隆git存储库的路径，并在该目录中执行脚本。

    管道中的使用 
    管道:—名称:java_pipeline步骤:—名称:step_1类型:Bash配置:inputResources:—名称:my_app_repo执行:onExecute:2022世界杯阿根廷预选赛赛程—pushd $res_my_app_repo_resourcePath—。/execute.sh—popd . conf

    例子6

    GitRepo资源在repo克隆期间使用HTTPS协议 
    2022世界杯阿根廷预选赛赛程资源:-名称:my_app_repo类型:GitRepo配置:gitProvider: my_github路径:myuser/repo-name branches: include: master cloneProtocol: https

    例7

    在这个例子中，GitRepo只更新到master的pull请求。

    GitRepo只触发对master的pull请求 
    2022世界杯阿根廷预选赛赛程资源:-名称:my_app_repo类型:GitRepo配置:gitProvider: my_github路径:myuser/repo-name pullRequestTargetBranches: include: ^master$ buildOn: commit: false pullRequestCreate: true
    • 没有标签
    版权所有©2023 JFrog Ltd.