├── .github
    ├── CODEOWNERS
    ├── dependabot.yml
    └── workflows
    │   ├── cd.yaml
    │   └── jenkins-security-scan.yml
├── .gitignore
├── .mvn
    ├── extensions.xml
    └── maven.config
├── Jenkinsfile
├── README.adoc
├── pom.xml
└── src
    └── main
        ├── java
            └── org
            │   └── jenkinsci
            │       └── plugins
            │           └── pipeline
            │               └── github
            │                   └── library
            │                       └── GitHubLibraryResolver.java
        └── resources
            └── index.jelly


/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @jenkinsci/pipeline-github-lib-plugin-developers
2 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 | - package-ecosystem: maven
 4 |   directory: /
 5 |   schedule:
 6 |     interval: monthly
 7 | - package-ecosystem: github-actions
 8 |   directory: /
 9 |   schedule:
10 |     interval: monthly
11 | 


--------------------------------------------------------------------------------
/.github/workflows/cd.yaml:
--------------------------------------------------------------------------------
 1 | # Note: additional setup is required, see https://www.jenkins.io/redirect/continuous-delivery-of-plugins
 2 | 
 3 | name: cd
 4 | on:
 5 |   workflow_dispatch:
 6 |   check_run:
 7 |     types:
 8 |       - completed
 9 | 
10 | jobs:
11 |   maven-cd:
12 |     uses: jenkins-infra/github-reusable-workflows/.github/workflows/maven-cd.yml@v1
13 |     secrets:
14 |       MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
15 |       MAVEN_TOKEN: ${{ secrets.MAVEN_TOKEN }}
16 | 


--------------------------------------------------------------------------------
/.github/workflows/jenkins-security-scan.yml:
--------------------------------------------------------------------------------
 1 | name: Jenkins Security Scan
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - master
 7 |   pull_request:
 8 |     types: [ opened, synchronize, reopened ]
 9 |   workflow_dispatch:
10 | 
11 | permissions:
12 |   security-events: write
13 |   contents: read
14 |   actions: read
15 | 
16 | jobs:
17 |   security-scan:
18 |     uses: jenkins-infra/jenkins-security-scan/.github/workflows/jenkins-security-scan.yaml@v2
19 |     with:
20 |       java-cache: 'maven' # Optionally enable use of a build dependency cache. Specify 'maven' or 'gradle' as appropriate.
21 |       # java-version: 21 # Optionally specify what version of Java to set up for the build, or remove to use a recent default.
22 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Maven build files
 2 | target/
 3 | 
 4 | # Jenkins plugin development
 5 | work/
 6 | 
 7 | # IntelliJ project files
 8 | *.iml
 9 | *.ipr
10 | *.iws
11 | .idea/
12 | 
13 | # Eclipse project files
14 | .settings/
15 | .classpath
16 | .project
17 | .metadata
18 | .loadpath
19 | 
20 | # NetBeans project files
21 | nbproject/private/
22 | build/
23 | nbbuild/
24 | dist/
25 | nbdist/
26 | nbactions.xml
27 | nb-configuration.xml
28 | 


--------------------------------------------------------------------------------
/.mvn/extensions.xml:
--------------------------------------------------------------------------------
1 | <extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
2 |   <extension>
3 |     <groupId>io.jenkins.tools.incrementals</groupId>
4 |     <artifactId>git-changelist-maven-extension</artifactId>
5 |     <version>1.8</version>
6 |   </extension>
7 | </extensions>
8 | 


--------------------------------------------------------------------------------
/.mvn/maven.config:
--------------------------------------------------------------------------------
1 | -Pconsume-incrementals
2 | -Pmight-produce-incrementals
3 | -Dchangelist.format=%d.v%s
4 | 


--------------------------------------------------------------------------------
/Jenkinsfile:
--------------------------------------------------------------------------------
 1 | /*
 2 |  See the documentation for more options:
 3 |  https://github.com/jenkins-infra/pipeline-library/
 4 | */
 5 | buildPlugin(
 6 |   useContainerAgent: true, // Set to `false` if you need to use Docker for containerized tests
 7 |   configurations: [
 8 |     [platform: 'linux', jdk: 21],
 9 |     [platform: 'windows', jdk: 17],
10 | ])
11 | 


--------------------------------------------------------------------------------
/README.adoc:
--------------------------------------------------------------------------------
 1 | == Pipeline: GitHub Groovy Libraries
 2 | 
 3 | Allows Pipeline Groovy libraries to be loaded on the fly from public repositories on GitHub.
 4 | Unlike regular library definitions, no preconfiguration at the global or folder level is needed.
 5 | 
 6 | Example:
 7 | 
 8 | [source,groovy]
 9 | ----
10 | @Library('github.com/jglick/sample-pipeline-library') _
11 | if (currentBuildExt().hasChangeIn('src')) {
12 |   return
13 | }
14 | node {
15 |   sh 'make'
16 | }
17 | ----
18 | 
19 | link:https://www.jenkins.io/doc/book/pipeline/shared-libraries/#automatic-shared-libraries[Documentation]
20 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!--
  3 | The MIT License
  4 | 
  5 | Copyright 2016, CloudBees, Inc.
  6 | 
  7 | Permission is hereby granted, free of charge, to any person obtaining a copy
  8 | of this software and associated documentation files (the "Software"), to deal
  9 | in the Software without restriction, including without limitation the rights
 10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 | copies of the Software, and to permit persons to whom the Software is
 12 | furnished to do so, subject to the following conditions:
 13 | 
 14 | The above copyright notice and this permission notice shall be included in
 15 | all copies or substantial portions of the Software.
 16 | 
 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 23 | THE SOFTWARE.
 24 | -->
 25 | 
 26 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 27 |   <modelVersion>4.0.0</modelVersion>
 28 | 
 29 |   <parent>
 30 |     <groupId>org.jenkins-ci.plugins</groupId>
 31 |     <artifactId>plugin</artifactId>
 32 |     <version>5.9</version>
 33 |     <relativePath/>
 34 |   </parent>
 35 | 
 36 |   <groupId>org.jenkins-ci.plugins</groupId>
 37 |   <artifactId>pipeline-github-lib</artifactId>
 38 |   <version>${changelist}</version>
 39 |   <packaging>hpi</packaging>
 40 | 
 41 |   <name>Pipeline: GitHub Groovy Libraries</name>
 42 |   <url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
 43 |   <licenses>
 44 |     <license>
 45 |       <name>MIT License</name>
 46 |       <url>https://opensource.org/licenses/MIT</url>
 47 |     </license>
 48 |   </licenses>
 49 | 
 50 |   <scm child.scm.connection.inherit.append.path="false" child.scm.developerConnection.inherit.append.path="false" child.scm.url.inherit.append.path="false">
 51 |     <connection>scm:git:https://github.com/${gitHubRepo}</connection>
 52 |     <developerConnection>scm:git:https://github.com/${gitHubRepo}</developerConnection>
 53 |     <tag>${scmTag}</tag>
 54 |     <url>https://github.com/${gitHubRepo}</url>
 55 |   </scm>
 56 | 
 57 |   <properties>
 58 |     <changelist>999999-SNAPSHOT</changelist>
 59 |     <gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
 60 |     <!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
 61 |     <jenkins.baseline>2.479</jenkins.baseline>
 62 |     <jenkins.version>${jenkins.baseline}.1</jenkins.version>
 63 |   </properties>
 64 | 
 65 |   <repositories>
 66 |     <repository>
 67 |       <id>repo.jenkins-ci.org</id>
 68 |       <url>https://repo.jenkins-ci.org/public/</url>
 69 |     </repository>
 70 |   </repositories>
 71 |   <pluginRepositories>
 72 |     <pluginRepository>
 73 |       <id>repo.jenkins-ci.org</id>
 74 |       <url>https://repo.jenkins-ci.org/public/</url>
 75 |     </pluginRepository>
 76 |   </pluginRepositories>
 77 | 
 78 |   <dependencyManagement>
 79 |     <dependencies>
 80 |       <dependency>
 81 |         <groupId>io.jenkins.tools.bom</groupId>
 82 |         <artifactId>bom-${jenkins.baseline}.x</artifactId>
 83 |         <version>3893.v213a_42768d35</version>
 84 |         <scope>import</scope>
 85 |         <type>pom</type>
 86 |       </dependency>
 87 |     </dependencies>
 88 |   </dependencyManagement>
 89 | 
 90 |   <dependencies>
 91 |     <dependency>
 92 |       <groupId>org.jenkins-ci.plugins</groupId>
 93 |       <artifactId>git</artifactId>
 94 |     </dependency>
 95 |     <dependency>
 96 |       <groupId>io.jenkins.plugins</groupId>
 97 |       <artifactId>pipeline-groovy-lib</artifactId>
 98 |     </dependency>
 99 |   </dependencies>
100 | 
101 | </project>
102 | 


--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/pipeline/github/library/GitHubLibraryResolver.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * The MIT License
 3 |  *
 4 |  * Copyright 2016 CloudBees, Inc.
 5 |  *
 6 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 |  * of this software and associated documentation files (the "Software"), to deal
 8 |  * in the Software without restriction, including without limitation the rights
 9 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 |  * copies of the Software, and to permit persons to whom the Software is
11 |  * furnished to do so, subject to the following conditions:
12 |  *
13 |  * The above copyright notice and this permission notice shall be included in
14 |  * all copies or substantial portions of the Software.
15 |  *
16 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 |  * THE SOFTWARE.
23 |  */
24 | 
25 | package org.jenkinsci.plugins.pipeline.github.library;
26 | 
27 | import hudson.Extension;
28 | import hudson.model.Job;
29 | import java.util.ArrayList;
30 | import java.util.Arrays;
31 | import java.util.Collection;
32 | import java.util.List;
33 | import java.util.Map;
34 | import jenkins.plugins.git.GitSCMSource;
35 | import jenkins.plugins.git.traits.IgnoreOnPushNotificationTrait;
36 | import org.jenkinsci.plugins.workflow.libs.LibraryConfiguration;
37 | import org.jenkinsci.plugins.workflow.libs.LibraryResolver;
38 | import org.jenkinsci.plugins.workflow.libs.SCMSourceRetriever;
39 | 
40 | /**
41 |  * Allows libraries to be loaded on the fly from GitHub.
42 |  */
43 | @Extension public class GitHubLibraryResolver extends LibraryResolver {
44 | 
45 |     @Override public boolean isTrusted() {
46 |         return false;
47 |     }
48 | 
49 |     @Override public Collection<LibraryConfiguration> forJob(Job<?,?> job, Map<String,String> libraryVersions) {
50 |         List<LibraryConfiguration> libs = new ArrayList<>();
51 |         for (Map.Entry<String,String> entry : libraryVersions.entrySet()) {
52 |             if (entry.getKey().matches("github[.]com/([^/]+)/([^/]+)")) {
53 |                 String name = entry.getKey();
54 |                 // Currently, GitHubSCMSource offers no particular advantage here over GitSCMSource.
55 |                 GitSCMSource scm = new GitSCMSource("https://" + name + ".git");
56 |                 scm.setTraits(Arrays.asList(
57 |                         new IgnoreOnPushNotificationTrait()
58 |                 ));
59 |                 LibraryConfiguration lib = new LibraryConfiguration(name, new SCMSourceRetriever(scm));
60 |                 lib.setDefaultVersion("master");
61 |                 libs.add(lib);
62 |             }
63 |         }
64 |         return libs;
65 |     }
66 | 
67 | }
68 | 


--------------------------------------------------------------------------------
/src/main/resources/index.jelly:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 | The MIT License
 4 | 
 5 | Copyright 2016 CloudBees, Inc.
 6 | 
 7 | Permission is hereby granted, free of charge, to any person obtaining a copy
 8 | of this software and associated documentation files (the "Software"), to deal
 9 | in the Software without restriction, including without limitation the rights
10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the Software is
12 | furnished to do so, subject to the following conditions:
13 | 
14 | The above copyright notice and this permission notice shall be included in
15 | all copies or substantial portions of the Software.
16 | 
17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 | THE SOFTWARE.
24 | -->
25 | 
26 | <?jelly escape-by-default='true'?>
27 | <div>
28 |   Allows Pipeline Groovy libraries to be loaded on the fly from GitHub.
29 | </div>
30 | 


--------------------------------------------------------------------------------