You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
* Update git triggers* Update git triggers and git provider integrationAdded Gerrit to git integrations,and updated structure and content of git triggers* Update git-triggers.mdAdded list of trigger events per provider supported by Codefresh* Update with feedbackReplaced description of Host URL for Gerrit; added mapping for Ref updated trigger* Update git-triggers.md* Update git-triggers.mdRemoved Push heads event from list of Gerrit triggers* Update content for gerritAdded Gerrit requirements to git integration, git triggers, and variables* Add Gerrit to GitOps* Update hosted runtime for Gerrit* Update with review feedbackImplemented review comments for Classic* Update Gerrit integration reqs for GitOpsAdded draft with initial screenshots* Update images for gerrit permissions* Update gerrit-integration.md* Add gerrit enrichers to ci-integrationsAdded gerrit credentials to hosted runtime and edited Gerrit integration* Add gerrit enricher arguments to all CI integrations* Update Gerrit requirementsUpdated permissions and HTTP password reqs in Gerrit; added section on using gerrit in codefresh* Add use gerrit in codefresh* Update gerrit-integration.md* Update content for gerrit integration topics
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,12 +87,16 @@ The table describes _all_ the arguments required for CI integrations in general.
87
87
|`CF_WORKFLOW_NAME`| The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform. Example,`Staging step`| Optional|
88
88
|`CF_GIT_BRANCH`| The Git branch with the commit and PR (pull request) data to add to the image. Pass the Branch from the event payload used to trigger your action.| Required|
89
89
|`CF_GIT_REPO`| The Git repository with the configuration and code used to build the image. {::nomarkdown} <ul><li>Optional for GitHub Actions. <li>Required for Codefresh pipelines and Jenkins.</li><ul>{:/}| Required|
90
-
|`CF_GIT_PROVIDER`| The Git provider for the integration, and can be either`github`,`gitlab`,or`bitbucket`. {::nomarkdown} <ul><li>Optional when you don't define other related Git provider arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Git provider arguments. For example, when you define <codeclass="highlighter-rouge">CF_GITLAB_TOKEN</code>, then you <i>must</i> define all Git provider arguments, in this case, <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">gitlab</code>, and <codeclass="highlighter-rouge">CF_GITLAB_HOST_URL</code>.</li><ul>{:/}| Optional|
90
+
|`CF_GIT_PROVIDER`| The Git provider for the integration, and can be either`github`,`gitlab`,`bitbucket`,`gerrit`. {::nomarkdown} <ul><li>Optional when you don't define other related Git provider arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Git provider arguments. For example, when you define <codeclass="highlighter-rouge">CF_GITLAB_TOKEN</code>, then you <i>must</i> define all Git provider arguments, in this case, <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">gitlab</code>, and <codeclass="highlighter-rouge">CF_GITLAB_HOST_URL</code>.</li><ul>{:/}| Optional|
91
91
|`CF_GITLAB_TOKEN`| The token to authenticate the GitLab account. {::nomarkdown} <ul><li>Optional when you don't define any GitLab-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the GitLab-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">gitlab</code>, or <codeclass="highlighter-rouge">CF_GITLAB_HOST_URL</code>.</li><ul>{:/}| Optional|
92
92
|`CF_GITLAB_HOST_URL`| The URL address of your GitLab Cloud/Server instance. {::nomarkdown} <ul><li>Optional when you don't define other related GitLab-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the GitLab-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">gitlab</code>, or <codeclass="highlighter-rouge">CF_GITLAB_TOKEN</code>.</li><ul>{:/}| Optional|
93
93
|`CF_BITBUCKET_USERNAME`| The username for the Bitbucket or the Bitbucket Server (on-prem) account. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_HOST_URL</code>.</li><ul>{:/}| Optional|
94
94
|`CF_BITBUCKET_PASSWORD`| The password for the Bitbucket or the BitBucket Server (on-prem) account. {::nomarkdown} <ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_USERNAME</code>, or <codeclass="highlighter-rouge">CF_BITBUCKET_HOST_URL</code>.</li><ul>{:/}| Optional|
95
-
|`CF_BITBUCKET_HOST_URL`| Relevant for Bitbucket Server accounts only. The URL address of your Bitbucket Server instance. Example,`https://bitbucket-server:7990`. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket Server-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. </li><li>Required when you define at least one of the Bitbucket Server-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <code class="highlighter-rouge"">CF_BITBUCKET_USERNAME</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code>.</li></ul>{:/}| Optional|
95
+
|`CF_BITBUCKET_HOST_URL`| Relevant only for Bitbucket Server accounts. <br>The URL address of your Bitbucket Server instance. Example,`https://bitbucket-server:7990`. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket Server-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. </li><li>Required when you define at least one of the Bitbucket Server-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <code class="highlighter-rouge"">CF_BITBUCKET_USERNAME</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code>.</li></ul>{:/}| Optional|
96
+
|`CF_GERRIT_CHANGE_ID`| Relevant only for Gerrit accounts. <br>The change ID or the commit message containing the Change ID to add to the image. For Gerrit, use this instead of`CF_GIT_BRANCH`.| Required|
97
+
|`CF_GERRIT_HOST_URL`| Relevant only for Gerrit accounts. <br> The URL of your website with the Gerrit instance, for example,`https://git.company-name.io`.| Required|
98
+
|`CF_GERRIT_USERNAME`| Relevant only for Gerrit accounts. <br> The username for your user account in Gerrit.| Required|
99
+
|`CF_GERRIT_PASSWORD`| Relevant only for Gerrit accounts. <br> The HTTP password for your user account in Gerrit, to use as the access token to authenticate HTTP requests to Gerrit.| Required|
96
100
|`CF_JIRA_PROJECT_PREFIX`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. One or more project prefixes in Jira to identify the Jira ticket number to use.<br>**NOTE**: Multiple project prefixes require runtime version 0.1.30 or higher. <br>To specify more than one prefix, use a comma-separated list or a regex. {::nomarkdown}<ul><li>Comma-separated list: <codeclass="highlighter-rouge">DEV,PROD,SAAS</code></li><li>Regex: Regex must start with a front slash <codeclass="highlighter-rouge">/</code> and end with <codeclass="highlighter-rouge">/g</code>. <br>Example: <codeclass="highlighter-rouge">/[A-Z]{2,}-\d+/g</code>.</li></ul>{:/}| Required|
97
101
|`CF_JIRA_MESSAGE`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The Jira issue IDs matching the string to associate with the image.| Required|
98
102
|`CF_JIRA_FAIL_ON_NOT_FOUND`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The report image action when the`CF_JIRA_MESSAGE` is not found. When set to`true`, the report image action is failed.| Required|
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations/codefresh-classic.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,6 +104,10 @@ For the complete argument reference, see [CI integration for GitOps argument ref
104
104
|`CF_BITBUCKET_USERNAME`| The username for the Bitbucket or the Bitbucket Server (on-prem) account. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_HOST_URL</code>.</li><ul>{:/}| Optional|
105
105
|`CF_BITBUCKET_PASSWORD`| The password for the Bitbucket or the Bitbucket Server (on-prem) account. {::nomarkdown} <ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_USERNAME</code>, or <codeclass="highlighter-rouge">CF_BITBUCKET_HOST_URL</code>.</li><ul>{:/}| Optional|
106
106
|`CF_BITBUCKET_HOST_URL`| Relevant for Bitbucket Server accounts only. The URL address of your Bitbucket Server instance. Example,`https://bitbucket-server:7990`. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket Server-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration.</li><li>Required when you define at least one of the Bitbucket Server-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_USERNAME</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code>.</li></ul>{:/}| Optional|
107
+
|`CF_GERRIT_CHANGE_ID`| Relevant only for Gerrit accounts. <br>The change ID or the commit message containing the Change ID to add to the image. For Gerrit, use this instead of`CF_GIT_BRANCH`.| Required|
108
+
|`CF_GERRIT_HOST_URL`| Relevant only for Gerrit accounts. <br> The URL of your website with the Gerrit instance, for example,`https://git.company-name.io`.| Required|
109
+
|`CF_GERRIT_USERNAME`| Relevant only for Gerrit accounts. <br> The username for your user account in Gerrit.| Required|
110
+
|`CF_GERRIT_PASSWORD`| Relevant only for Gerrit accounts. <br> The HTTP password for your user account in Gerrit, to use as the access token to authenticate HTTP requests to Gerrit.| Required|
107
111
|`CF_JIRA_PROJECT_PREFIX`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. One or more project prefixes in Jira to identify the Jira ticket number to use.<br>**NOTE**: Multiple project prefixes require version 0.1.30 or higher. <br>To specify more than one prefix, use a comma-separated list or a regex. {::nomarkdown}<ul><li>Comma-separated list: <codeclass="highlighter-rouge">DEV,PROD,SAAS</code></li><li>Regex: Regex must start with a front slash <codeclass="highlighter-rouge">/</code> and end with <codeclass="highlighter-rouge">/g</code>. <br>Example: <codeclass="highlighter-rouge">/[A-Z]{2,}-\d+/g</code>.</li></ul>{:/}| Required|
108
112
|`CF_JIRA_MESSAGE`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The Jira issue IDs matching the string to associate with the image.| Required|
109
113
|`CF_JIRA_FAIL_ON_NOT_FOUND`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The report image action when the`CF_JIRA_MESSAGE` is not found. When set to`true`, the report image action is failed.| Required|
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations/github-actions.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -119,6 +119,10 @@ The table describes the arguments required to connect a GitHub Action to Codefre
119
119
|`CF_WORKFLOW_NAME`| The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform. Example,`Staging step`| Optional|
120
120
|`CF_GIT_BRANCH`| The Git branch with the commit and PR (pull request) data to add to the image. Pass the Branch from the event payload used to trigger your action.| Required|
121
121
|`CF_GITHUB_TOKEN`| The GitHub authentication token. See[Git tokens]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens).| Required|
122
+
|`CF_GERRIT_CHANGE_ID`| Relevant only for Gerrit accounts. <br>The change ID or the commit message containing the Change ID to add to the image. For Gerrit, use this instead of`CF_GIT_BRANCH`.| Required|
123
+
|`CF_GERRIT_HOST_URL`| Relevant only for Gerrit accounts. <br> The URL of your website with the Gerrit instance, for example,`https://git.company-name.io`.| Required|
124
+
|`CF_GERRIT_USERNAME`| Relevant only for Gerrit accounts. <br> The username for your user account in Gerrit.| Required|
125
+
|`CF_GERRIT_PASSWORD`| Relevant only for Gerrit accounts. <br> The HTTP password for your user account in Gerrit, to use as the access token to authenticate HTTP requests to Gerrit.| Required|
122
126
|`CF_JIRA_PROJECT_PREFIX`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. One or more project prefixes in Jira to identify the Jira ticket number to use.<br>**NOTE**: Multiple project prefixes require version 0.1.30 or higher. <br>To specify more than one prefix, use a comma-separated list or a regex. {::nomarkdown}<ul><li>Comma-separated list: <codeclass="highlighter-rouge">DEV,PROD,SAAS</code></li><li>Regex: Regex must start with a front slash <codeclass="highlighter-rouge">/</code> and end with <codeclass="highlighter-rouge">/g</code>. <br>Example: <codeclass="highlighter-rouge">/[A-Z]{2,}-\d+/g</code>.</li></ul>{:/}| Required|
123
127
|`CF_JIRA_MESSAGE`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The Jira issue IDs matching the string to associate with the image.| Required|
124
128
|`CF_JIRA_FAIL_ON_NOT_FOUND`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The report image action when the`CF_JIRA_MESSAGE` is not found. When set to`true`, the report image action is failed.| Required|
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations/jenkins.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,6 +131,10 @@ The table describes the arguments to connect Codefresh pipelines to Codefresh Gi
131
131
|`CF_BITBUCKET_USERNAME`| The username for the Bitbucket or the Bitbucket Server (on-prem) account. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_HOST_URL</code>.</li><ul>{:/}| Optional|
132
132
|`CF_BITBUCKET_PASSWORD`| The password for the Bitbucket or the Bitbucket Server (on-prem) account. {::nomarkdown} <ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_USERNAME</code>, or <codeclass="highlighter-rouge">CF_BITBUCKET_HOST_URL</code>.</li><ul>{:/}| Optional|
133
133
|`CF_BITBUCKET_HOST_URL`| Relevant for Bitbucket Server accounts only. The URL address of your Bitbucket Server instance. Example,`https://bitbucket-server:7990`. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket Server-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration.</li><li>Required when you define at least one of the Bitbucket Server-specific arguments, such as <codeclass="highlighter-rouge">CF_GIT_PROVIDER</code> as <codeclass="highlighter-rouge">bitbucket</code>, <codeclass="highlighter-rouge">CF_BITBUCKET_USERNAME</code> or <codeclass="highlighter-rouge">CF_BITBUCKET_PASSWORD</code>.</li></ul>{:/}| Optional|
134
+
|`CF_GERRIT_CHANGE_ID`| Relevant only for Gerrit accounts. <br>The change ID or the commit message containing the Change ID to add to the image. For Gerrit, use this instead of`CF_GIT_BRANCH`.| Required|
135
+
|`CF_GERRIT_HOST_URL`| Relevant only for Gerrit accounts. <br> The URL of your website with the Gerrit instance, for example,`https://git.company-name.io`.| Required|
136
+
|`CF_GERRIT_USERNAME`| Relevant only for Gerrit accounts. <br> The username for your user account in Gerrit.| Required|
137
+
|`CF_GERRIT_PASSWORD`| Relevant only for Gerrit accounts. <br> The HTTP password for your user account in Gerrit, to use as the access token to authenticate HTTP requests to Gerrit.| Required|
134
138
|`CF_JIRA_PROJECT_PREFIX`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. One or more project prefixes in Jira to identify the Jira ticket number to use.<br>**NOTE**: Multiple project prefixes require version 0.1.30 or higher. <br>To specify more than one prefix, use a comma-separated list or a regex.{::nomarkdown}<ul><li>Comma-separated list: <codeclass="highlighter-rouge">DEV,PROD,SAAS</code></li><li>Regex: Regex must start with a front slash <codeclass="highlighter-rouge">/</code> and end with <codeclass="highlighter-rouge">/g</code>. <br>Example: <codeclass="highlighter-rouge">/[A-Z]{2,}-\d+/g</code>.</li></ul>{:/}| Required|
135
139
|`CF_JIRA_MESSAGE`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The Jira issue IDs matching the string to associate with the image.| Required|
136
140
|`CF_JIRA_FAIL_ON_NOT_FOUND`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The report image action when the`CF_JIRA_MESSAGE` is not found. When set to`true`, the report image action is failed.| Required|