Fix #551: Document credentials in global pipeline libraries
Give an example of how to provide credentials when using a global pipeline library in a private repository.
This commit is contained in:
parent
f10fb05d83
commit
fe7a766f00
|
|
@ -1,11 +1,11 @@
|
||||||
# configure global libraries plugin
|
# Configure global libraries plugin
|
||||||
|
|
||||||
Global Pipeline Libraries plugin configuration belongs under `unclassified` root element
|
Global Pipeline Libraries plugin configuration belongs under `unclassified` root element
|
||||||
|
|
||||||
## sample configuration
|
## Sample configuration
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
jenkins:
|
jenkins:
|
||||||
[...]
|
[...]
|
||||||
unclassified:
|
unclassified:
|
||||||
globalLibraries:
|
globalLibraries:
|
||||||
|
|
@ -17,3 +17,20 @@ unclassified:
|
||||||
git:
|
git:
|
||||||
remote: "https://github.com/jenkins-infra/pipeline-library.git"
|
remote: "https://github.com/jenkins-infra/pipeline-library.git"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Using credentials
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jenkins:
|
||||||
|
[...]
|
||||||
|
unclassified:
|
||||||
|
globalLibraries:
|
||||||
|
libraries:
|
||||||
|
- name: 'internal-pipeline-library'
|
||||||
|
retriever:
|
||||||
|
modernSCM:
|
||||||
|
scm:
|
||||||
|
git:
|
||||||
|
remote: 'git@github.com:furry-octo-lamp-inc/pipeline-library.git'
|
||||||
|
credentialsId: 'reimagined-parakeet-ssh'
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue