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
Copy file name to clipboardExpand all lines: _docs/integrations/git-providers.md
+32-26Lines changed: 32 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title:"Gitproviders"
2
+
title:"GitProviders"
3
3
description:"Easily checkout code in your pipelines"
4
4
group:integrations
5
5
redirect_from:
@@ -14,7 +14,7 @@ Creating an account with Codefresh using one of the supported Git providers (Git
14
14
15
15
You can add repositories from the other git providers regardless of the one that you used for sign-up. For example, you can use GitLab to sign up with Codefresh, but still build repositories that exist in Bitbucket.
16
16
17
-
You can even add multiple accounts from each Git provider (if you have more than one) allowing you to use Codefresh as a central CI/CD solution that can access all yourgit repositories regardless of the backinggit provider.
17
+
You can even add multiple accounts from each Git provider (if you have more than one) allowing you to use Codefresh as a central CI/CD solution that can access all yourGit repositories regardless of the backingGit provider.
18
18
19
19
Currently Codefresh supports:
20
20
@@ -27,31 +27,31 @@ Currently Codefresh supports:
27
27
* Atlassian Stash (old version of Bibucket Server)
28
28
* Bitbucket Server (new version of Stash)
29
29
30
-
Atlassian Stash/Bitbucket server as well as the on-premises version ofGiTlab and GitHub are only available to Codefresh enterprise customers.
30
+
Atlassian Stash/Bitbucket server as well as the on-premises version ofGitLab and GitHub are only available to Codefresh enterprise customers.
31
31
32
32
33
-
##Adding moreGIT providers to your Codefreshaccount.
33
+
##Adding moreGit providers to your CodefreshAccount
34
34
35
-
By default, you have direct access togit repositories that exist in theGIT provider that you used while signing up for Codefresh. You can easily create Codefresh projects that checkout code from thatGIT provider without any extra configurations.
35
+
By default, you have direct access toGit repositories that exist in theGit provider that you used while signing up for Codefresh. You can easily create Codefresh projects that checkout code from thatGit provider without any extra configurations.
36
36
37
-
To add additionalGIT providers, go to your Account Configuration, by clicking on*Account Settings* on the left sidebar. On the first section called*Integrations* click the*Configure* button next to*Git providers*.
37
+
To add additionalGit providers, go to your Account Configuration, by clicking on*Account Settings* on the left sidebar. On the first section called*Integrations* click the*Configure* button next to*Git providers*.
For eachgit provider you need to setup authentication, so Codefresh can get access to the public and private repositories of the respective platform.
52
+
For eachGit provider you need to setup authentication, so Codefresh can get access to the public and private repositories of the respective platform.
53
53
54
-
The easiest way to setup authentication is with OAuth2 if supported by thegit provider. You only need to name your integration
54
+
The easiest way to setup authentication is with OAuth2 if supported by theGit provider. You only need to name your integration
55
55
and Codefresh will automatically set it up once you accept the permissions required. If you have problems with OAuth2
56
56
or the provider does not support it, you need to manually create credentials by yourself in your git account and then enter them into Codefresh.
57
57
@@ -87,7 +87,7 @@ you used GitHub when you [created your Codefresh account]({{site.baseurl}}/docs/
87
87
88
88
For the**Access Token** method you need
89
89
90
-
* A friendly name for thegit context (it can be anything you want)
90
+
* A friendly name for theGit context (it can be anything you want)
91
91
* An access token
92
92
93
93
>Note that the access token for an organization should be created by somebody who has**Owner** role and not just**Member** role.
@@ -97,7 +97,7 @@ sidebar. Then select *Personal access tokens* from the left menu.
97
97
For more information see the[GitHub Documentation page](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/){:target="_blank"}
98
98
99
99
The "token description" you enter in your GitHub account in order to create the token is completely arbitrary (use "Codefresh" for an example). Once you have the token, paste it in the Codefresh UI and click*Test connection*. If everything is OK, you can
100
-
now save thegit integration.
100
+
now save theGit integration.
101
101
102
102
The minimum permissions for the token are:
103
103
-`repo.*`
@@ -115,15 +115,21 @@ alt="GitHub permissions"
115
115
For GitHub on-premises you also need to provide the URL of the GitHub server in your organization. If enabled in your account you can setup[Pipeline definition restrictions]({{site.baseurl}}/docs/administration/access-control/#pipeline-definition-restrictions) by expanding the*YAML Options* segment.
116
116
117
117
118
-
###Usingexternal secrets for thetoken
118
+
###UsingExternal Secrets for theToken
119
119
120
120
If your GitHub installation is behind your firewall, you can also
121
121
use any[external secrets that you have defined]({{site.baseurl}}/docs/integrations/secret-storage/) (such as Kubernetes secrets) as values by entering a secrets value
122
122
with the same syntax[shown in pipelines]({{site.baseurl}}/docs/configure-ci-cd-pipeline/secrets-store/).
123
123
124
124
For example if you already have a`token` on a resource call`git-credentials` you can put in the token field the expression {% raw %}`${{secrets.git-credentials.token}}`{% endraw %}.
125
125
126
+
###Level of Access
127
+
When the admin clicks off "Allow access to all users" another toggle appears; “Allow these credentials to be shared within a pipeline for cloning a repository“
128
+
1. When its turned on, the user that runs a pipeline will be able to clone the repo.
129
+
2. When its turned off, the user that runs a pipeline cannot use this integration.
130
+
In both cases, the user cannot decrypt the token used in Git integration with CLI or API.
126
131
132
+
>Important note: The credentials will be shared only to clone repos using an official git-clone step.
127
133
128
134
##GitHub-App
129
135
@@ -157,7 +163,7 @@ Also from the URL of the browser note the ending number (this is your installati
157
163
For the required fields use:
158
164
159
165
***Installation id** - found in step 5
160
-
***Appid** - found in step 3
166
+
***AppID** - found in step 3
161
167
***Private key** - the contents of the file your created in step 3 (but convert it to base64 first)
162
168
163
169
Click*Test connection* to verify your integration and apply your changes with the*Save* button. If enabled in your account you can setup[Pipeline definition restrictions]({{site.baseurl}}/docs/administration/access-control/#pipeline-definition-restrictions) by expanding the*YAML Options* segment.
@@ -170,7 +176,7 @@ you used GitLab when you [created your Codefresh account]({{site.baseurl}}/docs/
170
176
171
177
For the**Access Key** method you need:
172
178
173
-
* A friendly name for thegit context (it can be anything you want.)
179
+
* A friendly name for theGit context (it can be anything you want.)
174
180
* An access token/key
175
181
176
182
@@ -180,7 +186,7 @@ For more information see the [GitLab Documentation page](https://docs.gitlab.com
180
186
The name you enter in order to create the token in the GitLab UI is completely arbitrary (use "Codefresh" for an example)
181
187
182
188
Once you have the token, paste it in the Codefresh UI and click*Test connection*. If everything is OK can
183
-
now save thegit integration.
189
+
now save theGit integration.
184
190
185
191
For GitLab on-premises you also need to provide the URL of the GitLab server in your organization. If enabled in your account you can setup[Pipeline definition restrictions]({{site.baseurl}}/docs/administration/access-control/#pipeline-definition-restrictions) by expanding the*YAML Options* segment.
186
192
@@ -199,7 +205,7 @@ you used Bitbucket when you [created your Codefresh account]({{site.baseurl}}/do
199
205
200
206
For the**Application Password** method you need:
201
207
202
-
* A friendly name for thegit context (It can be anything you want.)
208
+
* A friendly name for theGit context (It can be anything you want.)
203
209
* The name of your Bitbucket account/email address
204
210
* A Bitbucket application password
205
211
@@ -218,7 +224,7 @@ alt="Bitbucket permissions"
218
224
%}
219
225
220
226
The "label" you enter in your Bitbucket account in order to create the application password is completely arbitrary (use "Codefresh" for an example). Once you have the token, paste it in the Codefresh UI and click*Test connection*. If everything is OK you can
221
-
now save thegit integration.
227
+
now save theGit integration.
222
228
223
229
If enabled in your account you can setup[Pipeline definition restrictions]({{site.baseurl}}/docs/administration/access-control/#pipeline-definition-restrictions) by expanding the*YAML Options* segment.
224
230
@@ -242,7 +248,7 @@ On the screen that will appear click the *New token* Button. Enter an arbitrary
242
248
Select an expiration date for your token
243
249
244
250
>At the time of writing Azure DevOps does not have the option to create a token that is valid for ever. Choose a large
245
-
time period and make sure that you have a policy in place for renewing your tokens so that Codefresh can continue to read yourGIT repo.
251
+
time period and make sure that you have a policy in place for renewing your tokens so that Codefresh can continue to read yourGit repo.
246
252
247
253
{% include image.html
248
254
lightbox="true"
@@ -315,24 +321,24 @@ with the same syntax [shown in pipelines]({{site.baseurl}}/docs/configure-ci-cd-
315
321
For example if you already have a`token` on a resource call`git-credentials` you can put in the token field the expression {% raw %}`${{secrets.git-credentials@token}}`{% endraw %}.
316
322
317
323
318
-
##Using yourgit provider
324
+
##Using yourGit provider
319
325
320
-
Once your provider is active, you can add a new project into Codefresh and then during the[repository selection screen]({{site.baseurl}}/docs/getting-started/create-a-basic-pipeline/) you will have access to the additionalgit providers.
326
+
Once your provider is active, you can add a new project into Codefresh and then during the[repository selection screen]({{site.baseurl}}/docs/getting-started/create-a-basic-pipeline/) you will have access to the additionalGit providers.
321
327
322
328
{% include image.html
323
329
lightbox="true"
324
330
file="/images/integrations/git/select-git.png"
325
331
url="/images/integrations/git/select-git.png"
326
332
max-width="60%"
327
-
caption="SelectGIT provider"
328
-
alt="SelectGIT provider"
333
+
caption="SelectGit provider"
334
+
alt="SelectGit provider"
329
335
%}
330
336
331
337
>Notice that for all supported Git providers Codefresh will automatically create all the webhooks needed for
332
338
triggering pipelines when a commit (or another event) happens.
333
339
334
-
After adding the repository Codefresh will behave exactly the same, regardless of the selectedgit provider.
335
-
You will be able to[create pipelines]({{site.baseurl}}/docs/configure-ci-cd-pipeline/pipelines/) for differentgit providers in exactly the same manner.
340
+
After adding the repository Codefresh will behave exactly the same, regardless of the selectedGit provider.
341
+
You will be able to[create pipelines]({{site.baseurl}}/docs/configure-ci-cd-pipeline/pipelines/) for differentGit providers in exactly the same manner.