Add a Windows wrapper macro 51/12651/4
authorThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 18 Sep 2018 22:38:14 +0000 (18:38 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 21 Sep 2018 02:25:08 +0000 (22:25 -0400)
We currently don't support ssh-agents on Windows. Split the wrapper
so that we have a Windows specific one.

Issue: RELENG-939
Change-Id: I0474206ddc706d8bb5c5c6762237bf227dc6cf82
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/jjb/lf-macros.rst
jjb/lf-macros.yaml
releasenotes/notes/windows-infra-wrapper-b40af1f40facc3d8.yaml [new file with mode: 0644]

index ce7ac0d..9f35594 100644 (file)
@@ -327,20 +327,33 @@ the GHPRB plugin and not manually.
 Wrappers
 ========
 
+lf-infra-wrappers-common
+------------------------
+
+Provides lf-infra recommended wrappers which should be used in every
+job-template. It's meant to be used by more specific wrappers below.
+
 lf-infra-wrappers
 -----------------
 
 Provides lf-infra recommended wrappers which should be used in every
-job-template.
+job-template that's run on Linux systems.
 
-This wrapper requires that a managed file called `npmrc` exists in the Jenkins.  The main use
-case here is to point to a npm proxy, on Nexus for example.
-The type of the file should be "Custom file".  You can set various npmrc settings in it.
-Documentation on npm configuration can be found at https://docs.npmjs.com/files/npmrc.
-If you are not using npm then it is fine for the file to be empty.
+This wrapper requires that a managed file called `npmrc` exists in the Jenkins.
+The main use case here is to point to a npm proxy, on Nexus for example.
+The type of the file should be "Custom file".  You can set various npmrc
+settings in it. Documentation on npm configuration can be found at
+https://docs.npmjs.com/files/npmrc. If you are not using npm then it is fine
+for the file to be empty.
 
 Example npmrc:
 
 .. code-block:: bash
 
    registry=https://nexus3.onap.org/repository/npm.public/
+
+lf-infra-wrappers-windows
+-------------------------
+
+Provides lf-infra recommended wrappers which should be used in every
+job-template that's run on Windows systems.
index d59a964..ac577c8 100644 (file)
 ############
 
 - wrapper:
-    name: lf-infra-wrappers
+    name: lf-infra-wrappers-common
     wrappers:
       - mask-passwords
       - timeout:
           timeout-var: 'BUILD_TIMEOUT'
           fail: true
       - timestamps
-      - ssh-agent-credentials:
-          users:
-            - '{jenkins-ssh-credential}'
       - openstack:
           single-use: true
+
+- wrapper:
+    name: lf-infra-wrappers
+    wrappers:
+      - lf-infra-wrappers-common:
+          build-timeout: '{build-timeout}'
       - config-file-provider:
           files:
             - file-id: npmrc
               target: '$HOME/.npmrc'
             - file-id: pipconf
               target: '$HOME/.config/pip/pip.conf'
+      - ssh-agent-credentials:
+          users:
+            - '{jenkins-ssh-credential}'
+
+- wrapper:
+    name: lf-infra-wrappers-windows
+    wrappers:
+      - lf-infra-wrappers-common:
+          build-timeout: '{build-timeout}'
diff --git a/releasenotes/notes/windows-infra-wrapper-b40af1f40facc3d8.yaml b/releasenotes/notes/windows-infra-wrapper-b40af1f40facc3d8.yaml
new file mode 100644 (file)
index 0000000..1f5a388
--- /dev/null
@@ -0,0 +1,9 @@
+---
+features:
+  - |
+    Add lf-infra-wrappers-windows to handle Windows specific wrapper
+    configuration.
+  - |
+    Refactor lf-infra-wrappers to be for Linux systems and split out the
+    non-linux specific components into a new lf-infra-wrappers-common. This
+    change is seamless for current users of lf-infra-wrappers.