From 6c95f20ca1bbc87c6ef8b85c63a2c6480fc31d14 Mon Sep 17 00:00:00 2001 From: Yuxiang Zhu Date: Mar 28 2019 15:11:31 +0000 Subject: Add typical usage of this library --- diff --git a/README.md b/README.md index 9295f56..6411094 100644 --- a/README.md +++ b/README.md @@ -15,5 +15,13 @@ The currently available global variables are: More complete documentation is in progress. ## Usage + +To dynamically import this library from the `master` branch, add the following lines to your `Jenkinsfile`: + +``` +library identifier: 'c3i@master', changelog: false, + retriever: modernSCM([$class: 'GitSCMSource', remote: 'https://pagure.io/c3i-library.git']) +``` + See the [Jenkins documentation](https://jenkins.io/doc/book/pipeline/shared-libraries/#using-libraries) for information on how to use this library from your pipelines.