Merge pull request #4 from electric-cloud-community/new-procedures

Added new procedures

Author: imago-storm

META-INF/plugin.xml

@@ -3,7 +3,7 @@
   <key>EC-Github</key>
   <label>EC-Github</label>
   <author>Polina</author>
-  <category>Utilities</category>
+  <category>Source Control</category>
   <description>CloudBees Flow integration for Github API</description>
   <configure>ec_config</configure>
   <version>2.0.0</version>

config/pluginspec.yaml

@@ -1,8 +1,10 @@
-pluginName: EC-Github
-version: 2.0.0
-description: CloudBees Flow integration for Github API
-author: Polina
-authorUrl: pshubina@cloudbees.com
+pluginInfo:
+  pluginName: EC-Github
+  version: 2.1.0
+  description: CloudBees Flow integration for Github API
+  author: Polina
+  authorUrl: pshubina@cloudbees.com
+  category: Source Control
 
 
 configuration:
@@ -125,6 +127,91 @@ procedures:
         label: Asset Path
         type: entry
 
+  - name: Upload Files
+    description: |
+      This procedure uploads the provided files into the provided repository
+    shell: ec-groovy
+    hasConfig: true
+    parameters:
+     - name: ownerName
+       required: true
+       label: Repository Owner
+       type: entry
+       documentation: The name of the user or organization which owns the repository
+     - name: repoName
+       required: true
+       label: Repository Name
+       type: entry
+       documentation: The name of the GH repository.
+     - name: sourceDirectory
+       required: false
+       type: entry
+       label: Source Directory
+       documentation: |
+        The directory resembling the repository source.
+        If not provided, the current directory will be used.
+        The relative paths of the files will be used to provide the path in the repository.
+     - name: mapping
+       documentation: |
+         A mapping in JSON form to provide the path to file in the repository, e.g.
+         {'file': "my/file"} where file is the path to the file relative to the source directory.
+       type: textarea
+       label: Mapping
+     - name: files
+       label: Files
+       documentation: |
+         A list of files relative to the source directory, newline-separated
+       type: textarea
+     - name: branch
+       label: Branch
+       value: master
+       type: entry
+       documentation: |
+        A branch name to commit files to.
+        If not master, the branch will be created from the master branch.
+     - name: createPr
+       type: checkbox
+       label: Create Pull Request?
+       checkedValue: true
+       uncheckedValue: false
+       documentation: |
+         If checked, a PR will be created for the updated files.
+
+  - name: Get Files
+    description: |
+      This procedure fetches the content of the specified files and stores it in
+      the filesystem or in the provided property
+    shell: ec-groovy
+    hasConfig: true
+    parameters:
+      - name: ownerName
+        required: true
+        label: Repository Owner
+        type: entry
+        documentation: The name of the user or organization which owns the repository
+      - name: repoName
+        required: true
+        label: Repository Name
+        type: entry
+        documentation: The name of the GH repository.
+      - name: files
+        required: true
+        label: Files
+        documentation: |
+          The newline-separated list of paths to the files
+        type: textarea
+      - name: destinationFolder
+        required: false
+        value: files
+        label: Folder to Save Files
+        type: entry
+        documentation: The folder to save retrieved files, absolute or relative path
+      - name: ref
+        label: Git Reference
+        required: false
+        value: master
+        documentation: Reference (branch, commit or tag to download file from)
+
 
   - name: Create Release
     description: This procedure can create a new Github Release or update an existing one.
@@ -148,6 +235,8 @@ procedures:
             value: recreate
           - name: Fail
             value: fail
+          - name: Update
+            value: update
 
       - name: releaseName
         label: Release Name
@@ -187,4 +276,4 @@ procedures:
         label: Delete Old Tag?
         documentation: If checked, the old tag associated with the old release will be deleted.
         checkedValue: true
-        uncheckedValue: false
+        uncheckedValue: false

dsl/com/electriccloud/commander/dsl/util/BasePlugin.groovy

@@ -1,4 +1,5 @@
 // Version: Thu Oct 25 16:10:18 2018
+// Please do not edit this file
 package com.electriccloud.commander.dsl.util
 
 import groovy.io.FileType

dsl/procedures/CreateConfiguration/procedure.dsl

@@ -1,6 +1,5 @@
 
-// === configuration starts ===
-// This part is auto-generated and will be regenerated upon subsequent updates
+// DO NOT EDIT THIS BLOCK === configuration starts ===
 procedure 'CreateConfiguration', description: 'Creates a plugin configuration', {
 
     step 'createConfiguration',
@@ -13,5 +12,5 @@ procedure 'CreateConfiguration', description: 'Creates a plugin configuration',
         timeLimitUnits: 'minutes'
 
     property 'ec_checkConnection', value: ''
-// === configuration ends, checksum: 8e292d191415a8f02e2350128b9946c2 ===
+// DO NOT EDIT THIS BLOCK === configuration ends, checksum: 5a7ab0ec556cc89190941f496f1191b0 ===
 }

dsl/procedures/CreateConfiguration/steps/createConfiguration.pl

@@ -1,25 +1,6 @@
 
-## === createConfiguration starts ===
-#
-#  Copyright 2016 Electric Cloud, Inc.
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-#
-
-#########################
-## createcfg.pl
-#########################
-
+## DO NOT EDIT THIS BLOCK === createConfiguration starts ===
+# Please do not edit this file
 use ElectricCommander;
 use ElectricCommander::PropDB;
 use JSON;
@@ -204,4 +185,4 @@ sub createConfigurationPropertySheet {
         $cfg->setCol("$opts->{config}", "$key", "$opts->{$key}");
     }
 }
-## === createConfiguration ends, checksum: b9c4ad2aeb2b3997dfbec1b845c4d7b4 ===
+## DO NOT EDIT THIS BLOCK === createConfiguration ends, checksum: 99e7a2462ebf0450ab27f98d7b6b987a ===

dsl/procedures/CreateRelease/form.xml

@@ -37,6 +37,10 @@
       <name>Fail</name>
       <value>fail</value>
     </option>
+    <option>
+      <name>Update</name>
+      <value>update</value>
+    </option>
   </formElement>
   <formElement>
     <type>entry</type>

dsl/procedures/CreateRelease/procedure.dsl

@@ -1,15 +1,16 @@
 // This procedure.dsl was generated automatically
-// === procedure_autogen starts ===
-procedure 'Create Release', description: 'This procedure can create a new Github Release or update an existing one.', {
+// DO NOT EDIT THIS BLOCK === procedure_autogen starts ===
+procedure 'Create Release', description: '''This procedure can create a new Github Release or update an existing one.''', {
 
     step 'Create Release', {
         description = ''
         command = new File(pluginDir, "dsl/procedures/CreateRelease/steps/CreateRelease.groovy").text
+        // TODO altered shell
         shell = 'ec-groovy'
 
         postProcessor = ''''''
     }
-// === procedure_autogen ends, checksum: e75ae2fc97e8d0b7207a3e3fb41bc80d ===
+// DO NOT EDIT THIS BLOCK === procedure_autogen ends, checksum: e1f39a29469ce11a5ea278b00706e4be ===
 // Do not update the code above the line
 // procedure properties declaration can be placed in here, like
 // property 'property name', value: "value"

dsl/procedures/CreateRepository/procedure.dsl

@@ -1,13 +1,14 @@
 
-// === procedure_autogen starts ===
-procedure 'Create Repository', description: 'Creates a GitHub Repository', {
+// DO NOT EDIT THIS BLOCK === procedure_autogen starts ===
+procedure 'Create Repository', description: '''Creates a GitHub Repository''', {
 
     step 'Create Repository', {
         description = ''
         command = new File(pluginDir, "dsl/procedures/CreateRepository/steps/CreateRepository.groovy").text
+        // TODO altered shell
         shell = 'ec-groovy'
 
         postProcessor = ''''''
     }
-// === procedure_autogen ends, checksum: 9e8e485c7e1c0c68e76405aa1ee22414 ===
+// DO NOT EDIT THIS BLOCK === procedure_autogen ends, checksum: 4f13e44746feee914ee6c05288698eef ===
 }

dsl/procedures/DeleteRelease/procedure.dsl

@@ -1,15 +1,16 @@
 // This procedure.dsl was generated automatically
-// === procedure_autogen starts ===
-procedure 'Delete Release', description: 'Deletes a tag and an attached release from Github', {
+// DO NOT EDIT THIS BLOCK === procedure_autogen starts ===
+procedure 'Delete Release', description: '''Deletes a tag and an attached release from Github''', {
 
     step 'Delete Release', {
         description = ''
         command = new File(pluginDir, "dsl/procedures/DeleteRelease/steps/DeleteRelease.groovy").text
+        // TODO altered shell
         shell = 'ec-groovy'
 
         postProcessor = ''''''
     }
-// === procedure_autogen ends, checksum: 420b71563fb3e061e50d6725cd7a8022 ===
+// DO NOT EDIT THIS BLOCK === procedure_autogen ends, checksum: 082f96095acf81c8caa3e5f42acd0304 ===
 // Do not update the code above the line
 // procedure properties declaration can be placed in here, like
 // property 'property name', value: "value"

dsl/procedures/DownloadReleaseAsset/procedure.dsl

@@ -1,15 +1,16 @@
 // This procedure.dsl was generated automatically
-// === procedure_autogen starts ===
-procedure 'Download Release Asset', description: 'Downloads the specified release asset from Github.', {
+// DO NOT EDIT THIS BLOCK === procedure_autogen starts ===
+procedure 'Download Release Asset', description: '''Downloads the specified release asset from Github.''', {
 
     step 'Download Release Asset', {
         description = ''
         command = new File(pluginDir, "dsl/procedures/DownloadReleaseAsset/steps/DownloadReleaseAsset.groovy").text
+        // TODO altered shell
         shell = 'ec-groovy'
 
         postProcessor = ''''''
     }
-// === procedure_autogen ends, checksum: ef595f86961464d70f2ced0e3197da86 ===
+// DO NOT EDIT THIS BLOCK === procedure_autogen ends, checksum: 186a88b00b674bdc1293a2d584c610a0 ===
 // Do not update the code above the line
 // procedure properties declaration can be placed in here, like
 // property 'property name', value: "value"