Skip to content

Commit

Permalink
docs(jenkins): Clarify that the credentials type should be for HTTP
Browse files Browse the repository at this point in the history
Later steps use the `usernamePassword()` pipeline function [1] which
assumes credentials to be composed of a username and password for HTTP
authentication. Clarify this to avoid users specifying e.g. SSH
credentials which would result in

    ERROR: Credentials 'jenkins-ssh' is of type 'SSH Username with private
    key' where 'com.cloudbees.plugins.credentials.common.StandardUsername
    PasswordCredentials' was expected

[1]: https://www.jenkins.io/doc/pipeline/steps/credentials-binding/

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Nov 21, 2023
1 parent bddecf4 commit b89610f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions integrations/jenkins/Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ pipeline {

credentials(
name: 'PROJECT_VCS_CREDENTIALS',
description: 'Optional Jenkins credentials to use for the VCS checkout.',
description: 'Optional HTTP credentials to use for the VCS checkout.',
defaultValue: ''
)

Expand All @@ -84,7 +84,7 @@ pipeline {

credentials(
name: 'ORT_CONFIG_VCS_CREDENTIALS',
description: 'Optional Jenkins credentials to use for the VCS checkout.',
description: 'Optional HTTP credentials to use for the VCS checkout.',
defaultValue: ''
)

Expand Down

0 comments on commit b89610f

Please sign in to comment.