diff --git a/README.md b/README.md index abbd0e6..93b2696 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,30 @@ ## Pipeline Triggerer Extension for Azure Pipelines ## - -The Pipeline Triggerer Extension include the following contributions: - -- Pipeline Trigger Task +This extension allows you to trigger any existing build or release definition. No matter if its implemented with the Classic Editor or YAML pipelines. +This is usefull when you need to orchestrate one or several pipelines from your authored pipeline. ![Extension ADO Pipeline Trigger Task](/static/images/ext-pipeline-trigger-task-ui.png) -![Extension ADO Service EndPoint](/static/images/ext-service-endpoint.png) -### Quick steps to get started ### +### Highlights ### +> This extension is ***cross platform***. You can run it from **Windows**, **Linux** or **macOS** self-hosted agents. +> This extension allows you to orchestrate pipelines accross different **projects** or **organizations** -To make the Pipeline Trigger Task available, you must: -- Configure a service end-point in Azure DevOps for accessing the ADO Rest Api; -- Use the Pipeline Trigger Task in your build/release definitions. +The Pipeline Triggerer Extension include the following contributions: + +1. Pipeline Triggerer Task -Please refer to the following information: -- [Getting Started](https://github.com/joalmeid/pipeline-triggerer/wiki) +![Extension ADO Pipeline Triggerer Task](/static/images/ext-pipeline-trigger-task-ui-classical.png) +2. Azure Devops Service Connection +![Extension ADO Service EndPoint](/static/images/ext-service-endpoint.png) +Don't know how to get started? Well it's easy as: + 1. Create your Service Endpoint + 2. Add the `Pipeline Triggerer Task` to any of your build or release pipelines + 3. Configure the `Pipeline Triggerer Task` + 4. Run your pipeline! ## Release status diff --git a/src/overview.md b/src/overview.md index 9dc3366..3898521 100644 --- a/src/overview.md +++ b/src/overview.md @@ -1,18 +1,60 @@ ## Pipeline Triggerer Extension ## +This extension allows you to trigger any existing build or release definition. No matter if its implemented with the Classic Editor or YAML pipelines. +This is usefull when you need to orchestrate one or several pipelines from your authored pipeline. + +![Extension ADO Pipeline Trigger Task](/static/images/ext-pipeline-trigger-task-ui.png) + +### Highlights ### +> This extension is ***cross platform***. You can run it from **Windows**, **Linux** or **macOS** self-hosted agents. +> This extension allows you to orchestrate pipelines accross different **projects** or **organizations** + The Pipeline Triggerer Extension include the following contributions: -- Pipeline Trigger Task +1. Pipeline Triggerer Task + +![Extension ADO Pipeline Triggerer Task](/static/images/ext-pipeline-trigger-task-ui-classical.png) + +2. Azure Devops Service Connection -![Extension ADO Pipeline Trigger Task](/static/images/ext-pipeline-trigger-task-ui.png) ![Extension ADO Service EndPoint](/static/images/ext-service-endpoint.png) +Don't know how to get started? Well it's easy as: + 1. Create your Service Endpoint + 2. Add the `Pipeline Triggerer Task` to any of your build or release pipelines + 3. Configure the `Pipeline Triggerer Task` + 4. Run your pipeline! + +### Prerequisites ### +- You must have an active Azure subscription. Create a new subscription at https://azure.com. +- You must also have an active Azure DevOps account and an organization. Create a new account at https://dev.azure.com. +- Install this extension to your organization. To do this, you must be an admin of the organization. + - Once installed, you may have to have your admin make the extension available to you or your project. +- Create a service connection to your Azure Devops Organization in your DevOps project. + +The name of this service connection is what you will use in the `Pipeline Triggerer Task` for the input *'Azure DevOps service connection'* if you are using the Classical Editor. If you're authoring YAML pipelines, it's the input `adoConnectedServiceName`. + ### Quick steps to get started ### -To make the Pipeline Trigger Task available, you must: +To make the Pipeline Triggerer Task available, you must: - Configure a service end-point in Azure DevOps for accessing the ADO Rest Api; -- Use the Pipeline Trigger Task in your build/release definitions. +- Use the Pipeline Triggerer Task in your build/release definitions. -Please refer to the following information: -- [Getting Started](https://github.com/joalmeid/pipeline-triggerer/wiki) +### Pipeline Triggerer Task ### +```yaml +# Pipeline Triggerer Task +# Trigger any build or release definition in any organization/project +- task: pipeline-triggerer-task@0 + inputs: + #adoServiceConnection: The Azure DevOps Organization service connection that should be used to connect to Azure DevOps. # Required. + #Project: Name of the team project were the pipeline resides. # Required. + #PipelineType: The type of pipeline # Required. Options: Build, Release + #BuildDefinition: The name of the Build to trigger. # Required when PipelineType == Build. + #ReleaseDefinition: The name of the Release to trigger. # Required when PipelineType == Release. + #ReleaseDescription: The description of the release. # Optional. + #Branch: The name of the branch to build. When kept empty the default branch of the build will be used. # Optional. + #BuildNumber: The succeeded build number to release of the primary artifact. When kept empty the latest version is used. # Optional. + #Async: The async flag defines whether the build task waits till the builds are finished or just queues them. # Optional. + #PipelineIdOutputVariable: Variable name used to write the resulting build/release id's. # Optional. +``` \ No newline at end of file diff --git a/src/pipeline-trigger-task/pipelinetriggerV1/task.json b/src/pipeline-trigger-task/pipelinetriggerV1/task.json index cac4667..0126cef 100644 --- a/src/pipeline-trigger-task/pipelinetriggerV1/task.json +++ b/src/pipeline-trigger-task/pipelinetriggerV1/task.json @@ -30,9 +30,7 @@ "type": "connectedService:ADOAPI", "label": "Azure DevOps service connection", "required": "true", - "aliases": [ - "serviceConnection" - ], + "aliases": [ "adoServiceConnection" ], "defaultValue": "", "helpMarkDown": "Select the Azure DevOps Organization service connection that should be used to connect to Azure DevOps" }, @@ -42,6 +40,7 @@ "label": "Project", "defaultValue": "", "required": true, + "aliases": [ "Project" ], "helpMarkDown": "Select the name of the team project were the pipeline resides.", "properties": { "EditableOptions": "True" @@ -52,6 +51,7 @@ "label": "Pipeline type", "type": "pickList", "required": true, + "aliases": [ "PipelineType" ], "helpMarkDown": "Select the type of pipeline", "defaultValue": "Release", "options": { @@ -65,6 +65,7 @@ "label": "Build Definition", "defaultValue": "", "required": true, + "aliases": [ "BuildDefinition" ], "helpMarkDown": "Select the name of the Build to trigger.", "visibleRule": "avPipeline = Build", "properties": { @@ -77,6 +78,7 @@ "label": "Release Definition", "defaultValue": "", "required": true, + "aliases": [ "ReleaseDefinition" ], "helpMarkDown": "Select the name of the Release to trigger.", "visibleRule": "avPipeline = Release", "properties": { @@ -88,6 +90,7 @@ "type": "string", "label": "Release description", "required": false, + "aliases": [ "ReleaseDescription" ], "helpMarkDown": "The description of the release", "visibleRule": "avPipeline = Release" }, @@ -96,6 +99,7 @@ "type": "string", "label": "Branch", "required": false, + "aliases": [ "Branch" ], "helpMarkDown": "The name of the branch to build. When kept empty the default branch of the build will be used.", "visibleRule": "avPipeline = Build" }, @@ -104,6 +108,7 @@ "type": "string", "label": "Build Number", "defaultValue": "", + "aliases": [ "BuildNumber" ], "required": false, "helpMarkDown": "The succeeded build number to release of the primary artifact. When kept empty the latest version is used.", "visibleRule": "avPipeline = Release" @@ -113,6 +118,7 @@ "type": "boolean", "label": "Async", "defaultValue": false, + "aliases": [ "Async" ], "required": true, "helpMarkDown": "The async flag defines whether the build task waits till the builds are finished or just queues them.", "groupName": "advanced" @@ -123,6 +129,7 @@ "label": "Pipeline Id Output Variable", "defaultValue": "", "required": false, + "aliases": [ "PipelineIdOutputVariable" ], "helpMarkDown": "Variable name used to write the resulting build/release id's.", "groupName": "advanced" } diff --git a/src/static/images/pipeline-triggerer-service-endpoint.png b/src/static/images/pipeline-triggerer-service-endpoint.png index a661692..564070d 100644 Binary files a/src/static/images/pipeline-triggerer-service-endpoint.png and b/src/static/images/pipeline-triggerer-service-endpoint.png differ diff --git a/src/static/images/pipeline-triggerer-task-ui-classical-add.png b/src/static/images/pipeline-triggerer-task-ui-classical-add.png new file mode 100644 index 0000000..a458651 Binary files /dev/null and b/src/static/images/pipeline-triggerer-task-ui-classical-add.png differ diff --git a/src/static/images/pipeline-triggerer-task-ui-classical.png b/src/static/images/pipeline-triggerer-task-ui-classical.png new file mode 100644 index 0000000..5f56031 Binary files /dev/null and b/src/static/images/pipeline-triggerer-task-ui-classical.png differ