Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 3.69 KB

Installation.md

File metadata and controls

79 lines (49 loc) · 3.69 KB
Raw

Installation

As this extension contains a pipeline-decorator, it cannot be converted to a publicly available extension in the marketplace. This document outlines how you can install this extension in your Azure DevOps Organization.

You have three possible options:

  1. Install via Sharing
  2. Fork and Publish
  3. Install Manually (Azure DevOps Server Only)

Install via Sharing

A private extension can be "shared" so that it is made available to your Azure DevOps Organization. Once shared, your Project Collection Administrator can install it through the link available in General > Extensions : Shared tab.

Shared Tab

To add your organization to the extension's shared list, open an issue and provide your details.

Fork and Publish

You may choose to publish this extension to your own organization.

Azure DevOps setup:

  1. Fork this repository

    • Please Star or Fork the repository so that I know this extension is being used :-)

  2. Create a new Project in your Azure DevOps Organization and link the GitHub repository.

    • Alternatively, you can import the git repository into an Azure DevOps repository.

  3. Install the Azure DevOps Extensions Tasks and follow their "How to use" instructions on how to setup a PAT token that can communicate with the marketplace.

  4. In your Azure DevOps Project, create a "Visual Studio Marketplace" Service-Connection that uses the PAT token

  5. Create a variable group pipeline-extension-settings and add the following:

    Name Value
    ExtensionsId name of the extension, eg deploymentqueuingdecorator
    Extension Name display name for the decorator.
    PublisherId your publisher name in the marketplace
    SharedWith comma-delimited list of azure devops organizations

  6. Create a new Pipeline and link it to the existing YAML pipeline /devops/pipelines/marketplace-extension/pipeline.yml

Marketplace Setup:

  1. Login to the Marketplace (https://marketplace.visualstudio.com) using the same identity that you used to create the PAT token.

  2. Click on the Publish extensions link

  3. Click on the Create Publisher button and fill in the basic details.

  4. Before you can run the pipeline, the extension must exist in the marketplace:

    1. Clone the repository locally
    2. Install tfx extensions: npm install -g tfx-cli
    3. Modify the /src/vssextension.json to match the values in the variable group above:
      • extension name
      • publisher name
    4. Create the extension: tfx extension create -r src

  5. Upload the extension (*.vsix) to your publisher.

  6. Share the extension with your organization. (Optional, because the pipeline will also share with the organizations you specified in the SharedWith variable)

Now you can run the pipeline to promote changes or share with additional organizations of your choosing.

Install Manually (Azure DevOps Server)

  1. Download the latest published release (TODO)
  2. Navigate to <https://<your-server>/_gallery/manage> and upload the extension.