Skip to content

Commit 3b14d30

Browse files
authored
Update USER_GUIDE.adoc (#885)
Mention that the `Checkout Credential` was removed, and the alternative approach to configure a SSH credential for checkout in USER_GUIDE. closes #715
1 parent a4118fc commit 3b14d30

File tree

3 files changed

+5
-9
lines changed

3 files changed

+5
-9
lines changed

docs/USER_GUIDE.adoc

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -104,18 +104,14 @@ properly configured in _Manage Jenkins_ » _Configure System_
104104
[id=bitbucket-creds-config]
105105
== Credentials configuration
106106

107-
The configuration of the plugin (for both _Bitbucket multibranch pipelines_ and _Bitbucket Workspace/Project organization folders_) has
108-
two credentials to configure:
109-
110-
. *Scan Credentials*: Credentials used to access Bitbucket API in order to discover repositories, branches and pull requests.
111-
If not set then anonymous access is used, so only public repositories, branches and pull requests are discovered and managed.
112-
HTTP Basic Authentication, Access Token and OAuth credentials are supported.
113-
. *Checkout Credentials*: Credentials used to check out sources once the repository, branch or pull request is discovered.
114-
HTTP Basic Authentication, SSH and OAuth credentials are supported.
115-
If not set, then _Scan Credentials_ are used.
107+
The plugin (for both _Bitbucket multibranch pipelines_ and _Bitbucket Workspace/Project organization folders_) requires a credential to be configured to scan branches. It will also be the default credential to use when checking out sources.
116108

117109
image::images/screenshot-3.png[scaledwidth=90%]
118110

111+
As the `Checkout Credential` configuration was removed in commit (link:https://github.com/jenkinsci/bitbucket-branch-source-plugin/commit/a4c6bf39b83168ff62fc622bd4084ef90cf810c0[a4c6bf3]), you can alternatively add a `Checkout over SSH` behavior in the configuration of Behaviours, so that to configure a seperate SSH credential for checking out sources.
112+
113+
image::images/screenshot-7.png[scaledwidth=90%]
114+
119115
=== Access Token
120116

121117
The plugin can make use of a personal access token (Bitbucket Server only) instead of the standard username/password.

docs/images/screenshot-3.png

489 KB
Loading

docs/images/screenshot-7.png

63.2 KB
Loading

0 commit comments

Comments
 (0)