Azure DevOps Extensions Workshop

Pipelines	Status
Extension build and release
Extension consumer

This repository contains modules for the workshop on building azure devops extensions to help collegues get started with azure devops extensions

Table of Contents (click to open)

• Great to Have
• Preparing the extension
  • Setup the workspace
  • Setup the marketplace service connection
  • Create the publisher
  • Setup the Azure DevOps Pipeline
• Using the extension
  • Install the extension
  • Setup the consumer pipeline
• FAQ

Great to Have

The workshop assumes that you have access to the following resources:

• Azure DevOps Account
• Node.js
• Linux or WSL on Windows
• GNU Make (Optional) Windows

The workshop assumes that you have basic knowledge on:

• Javascript/Typescript
• Sinon, Mocha, Chai testing

Preparing the extension

Setup the workspace

1. Sign in to Azure DevOps using your personal microsoft account.

2. Create an organization. You can provide any name, make sure it's a unique one.

3. Create a project by clicking the New Project button.

   The project will hoist your extension-code and release pipeline.

4. Create a repository in the first project space for your extension code.

5. We'll need to install the necessary Azure DevOps Extension Tasks by Microsoft installed to build and release azure devops extensions.

   • Install the extension.

     

   • Check if the extension is correctly installed by visiting -> Organization settings -> Extensions.

     

6. Clone the repository code and delete the current git remote using below steps. (We will upload the same code to the azure repository).

   # Git clone the repository
   git clone https://github.com/Biswajee/Azure-DevOps-Extensions-Workshop.git
   
   # Remove the remote url for the cloned repo
   git remote remove origin
   
   # Add the new remote url from your azure devops extension repository
   git remote add origin https://<OrganizationName>@dev.azure.com/<OrganizationName>/<ProjectName>/_git/<AzureRepositoryName>
   git push -u origin --all

7. Check whether the code you've pushed got successfully updated in the azure devops respository.

Horray! You've completed the first subtask 🎉🎉

Setup the marketplace service connection

1. Go to the project space where your extension repository is present.

2. [User Settings] > [Personal access tokens] > [ + New Token].

   Select All accessible organizations under Organization while setting up the token. Please provide full access to your token for the demo purpose. Generate your token and keep a copy of the same.

   

3. [Project Settings] > [Service Connections] > [Create Service Connection].

4. In the search bar, find Visual Studio Marketplace. Click Next.

   

5. Add your personal access token that you copied earlier.

6. Provide the name of the service connection and an optional description.

7. Make sure the Grant access permission to all pipelines is checked ✅.

Please note the name of the service connection after creating.

Create the publisher

1. Go to the publish your extension page and create a publisher. Please note the publisher ID after creating.

(Any details other than the name of the publisher and the publsher id are optional.)

Setup the Azure DevOps Pipeline

The Azure DevOps pipeline is located at the root of the project here. Please update the values in the variable section of the pipeline (Line 19 to 29) as under:

variables:
  # the publisher id you've created
  publisherId: <YOUR-PUBLISHER-ID>
  # the value of url after https://dev.azure.com/<YOUR-ORGANIZATION-NAME>
  # this value will be used to share the produced extension with the organization
  # multiple values can be provided as shown: organization1,organization2
  shareWithOrganization: <YOUR-ORGANIZATION-NAME>
  # example of organization url: https://dev.azure.com/biswajitr
  shareWithOrganization.URLs: <YOUR-ORGANIZATION-URL> 
  # the name of the marketplace service connection that you've created
  marketplaceServiceConnectionName: <YOUR-MARKETPLACE-SERVICE-CONNECTION>

Now, we're ready to create our first pipeline 🎉

1. Click the pipelines icon in the azure devops platform.

2. Click on [ New Pipeline ] button.

3. Select following responses when prompted:

   • Where is your code: Azure Repos Git

   • Select a repository:

   • Configure your pipeline: Existing Azure Pipelines YAML file

   • Enter pipeline path as: /az-build-and-release-pipeline.yaml

Click on continue to setup your pipeline.

Review your pipeline YAML and hit run to execute the pipeline.

Using the extension

Now that your build and release pipelines executed successfully, we can test our extension using another pipeline. Before, we can do that you must ensure that the extension is shared with the organization where you're trying to use.

Install the extension

The azure devops extension gets automatically installed in the target organization when the build is triggered using the azure pipelines.

You can verify whether the extension is installed properly by visiting -> Organization settings -> Extensions. or https://dev.azure.com/<OrganizationName>/_settings/extensions?tab=installed.

Setup the consumer pipeline

Now, we are ready to test our azure devops extension tasks in all the shared organizations. Your personal Azure DevOps might allow pipelines to execute only in one project space. If you're able to run pipelines in different projects in the same organization, you can set up the below pipeline anywhere within the shared organizations.

1. Create another repository in the same organization and project.

2. Create a new pipeline using the following steps:

   1. Click the pipelines icon in the azure devops platform.

   2. Click on [ New Pipeline ] button.

   3. Select following responses when prompted:

      • Where is your code: Azure Repos Git

      • Select the repository:

      • Configure your pipeline: Starter pipeline

3. Look for the HelloWorld and TwoSum tasks in the tasks pane. And add them.

4. Your final pipeline should look like below yaml.

   trigger:
   # the current branch that you're in
   - main
   - master
   
   pool:
     vmImage: ubuntu-20.04
   
   steps:
   - task: HelloWorld@0
   - task: TwoSum@0
     inputs:
       firstNumber: '7'
       secondNumber: '6'

Please refer to the successful release and test pipelines here.

FAQ

The Azure pipelines fails after creating the pipeline

If you face the below error message, please have a look at the Getting-Started document.

No hosted parallelism has been purchased or granted. To request a free parallelism grant, please fill out the following form https://aka.ms/azpipelines-parallelism-request

If you encounter other issues, please let our SMEs know about it 😊

The pipeline fails during 'Run tests' step

Please consider checking if your program produces the expected output. Possibly, you've forgotten to modify the logic inside the src > TwoSum > index.ts file.

How can I edit the details in the extension page?

Please find the overview.md and modify it's contents to update the extension page.

Conclusion

Thank you for joining the session to learn and perform hands-on with the Azure DevOps Extension exercises. Learn more about building azure devops extensions and its advantages here.