Back to Top
Specify Helix Repository connection settings and get changes submitted to this repository. Choose what information should be included in changes report.
Get Changeset list
| Class Name | com.midvision.rapiddeploy.plugins.library.helix.task.GetChangesetListTask |
| Category | Helix Versioning Engine |
Get Changeset list
Description
Retrieve all the changes submitted to specified helix repository:Specify Helix Repository connection settings and get changes submitted to this repository. Choose what information should be included in changes report.
Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| changeOwner | java.lang.String | true | The username who submitted the change.Leave this field blank if you want to retrieve the history for all users. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| helixRepositoryUrl | java.lang.String | public.perforce.com:1666 | false | The TFS Repository URL of the RapidDeploy project. This is the URL to the top level of the repository. |
| maxNumberOfCommits | java.lang.String | 3 | false | Maximum number of commits which will be included in change report. |
| outputParameter | java.lang.String | ${changesetOutput} | false | The name of the output parameter, which can pass the return value from the task. The task output will be the Helix changeset output. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${changesetOutput}. |
| password | java.lang.String | true | Password to use to authenticate when connecting to Helix (if required). | |
| showAffectedFiles | java.lang.Boolean | true | false | Specify if you want to see changelist affected files in the task output. |
| showChangelistClientId | java.lang.Boolean | false | false | Specify if you want to see changelist clientId in the task output. |
| showChangelistDate | java.lang.Boolean | true | false | Specify if you want to see changelist date in the task output. |
| showChangelistDescription | java.lang.Boolean | true | false | Specify if you want to see changelist description in the task output. |
| showChangelistID | java.lang.Boolean | true | false | Specify if you want to see changelist ID in the task output. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| username | java.lang.String | guest | false | The username to use to connect to the Helix Repository. |
Back to Top
checkout - Checkout a folder from Helix. If the local working copy already exists, just update it.
submitEditedFile - Commit the contents of the local working copy to the repository which have been modified. Specify local working directory using Perforce client or depot or local path format
submitAddedFile - Commit the contents of the local working copy to the repository which have been added. Specify local working directory using Perforce client or depot or local path format
resynchronise - Delete the local working copy (if it exists) and then perform a new checkout.
deleteFile - Delete a file from the local working copy - this change will be submited to Helix Server. Specify local working directory using Perforce client or depot or local path format
Helix Repository Operations
| Class Name | com.midvision.rapiddeploy.plugins.library.helix.task.HelixRepositoryOperations |
| Category | Helix Versioning Engine |
Helix Repository Operations
Description
Perform a task against the Helix repository. Select from one of:checkout - Checkout a folder from Helix. If the local working copy already exists, just update it.
submitEditedFile - Commit the contents of the local working copy to the repository which have been modified. Specify local working directory using Perforce client or depot or local path format
submitAddedFile - Commit the contents of the local working copy to the repository which have been added. Specify local working directory using Perforce client or depot or local path format
resynchronise - Delete the local working copy (if it exists) and then perform a new checkout.
deleteFile - Delete a file from the local working copy - this change will be submited to Helix Server. Specify local working directory using Perforce client or depot or local path format
Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| filePath | java.lang.String | true | The path to the file. Required for submitEditedFile,submitAddedFile,deleteFile operations. | |
| helixRepositoryUrl | java.lang.String | public.perforce.com:1666 | false | The TFS Repository URL of the RapidDeploy project. This is the URL to the top level of the repository. |
| localWorkingDirectory | java.lang.String | /tmp/helix-samples | false | The location on the file system where the local Helix Working Copy directory will reside. |
| mappingServerPath | java.lang.String | //guest/perforce_software/p4java/main/samples/basic/... | false | Set this to a writable Helix server folder (like "//depot/yourProject/...") - this is the path to the project/branch location inside your repository. |
| operation | java.util.List | checkout | false | The operation to perform. One of: checkout,submitEditedFile,submitAddedFile,resynchronise,deleteFile. The submitEditedFile, submitAddedFile, deleteFile require a filePath entry. |
| outputParameter | java.lang.String | ${helixOutput} | false | The name of the output parameter, which can pass the return value from the task. The task output will be the Helix output. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${helixOutput}. |
| password | java.lang.String | true | Password to use to authenticate when connecting to Helix (if required). | |
| retryCount | java.lang.String | 1 | false | The retry count. The number of times to retry a Helix call, before failing. The time between successive retry calls is set with the "retryInterval" setting |
| retryInterval | java.lang.String | 5000 | false | The retry interval in milliseconds. If set, the amount of time to wait before retrying a Helix call. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| submitDescription | java.lang.String | true | The comment you want to add to your submit action. Required for submitEditedFile,submitAddedFile,deleteFile operations. | |
| username | java.lang.String | guest | false | The username to use to connect to the Helix Repository. |