Поделиться через


Разработка веб-расширения

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Используйте расширения для улучшения Azure DevOps с новыми веб-интерфейсами, мини-приложениями панели мониторинга, задачами сборки и т. д. Расширения можно разрабатывать с помощью стандартных технологий, таких как HTML, JavaScript и CSS. В этом руководстве описано, как создать веб-расширение для Azure DevOps.

Совет

Ознакомьтесь с примерами расширений и новой документацией по разработке расширений с помощью пакета SDK для расширения Azure DevOps.

Необходимые компоненты

У вас должно быть следующее разрешение и установка.

Создание каталога и манифеста

Расширение состоит из набора файлов, включающих обязательный файл манифеста. Упаковав его в VSIX-файл и опубликуйте его в Visual Studio Marketplace.

  1. Создайте каталог для хранения файлов, необходимых для расширения:

    mkdir my-first-extension
    
  2. В этом каталоге инициализировать новый манифест пакета npm:

    npm init -y
    

    Этот файл описывает библиотеки, необходимые вашему расширению.

  3. Установите пакет пакета SDK для веб-расширений Microsoft VSS и сохраните его в манифесте пакета npm:

    npm install azure-devops-extension-sdk --save
    

    Этот пакет SDK включает библиотеку JavaScript, которая предоставляет API-интерфейсы, необходимые для взаимодействия со страницей, в которую внедрено расширение.

  4. Создайте файл манифеста расширения с именем vss-extension.json в корневом каталоге расширения со следующим содержимым:

    {
        "manifestVersion": 1,
        "id": "my-first-extension",
        "publisher": "",
        "version": "1.0.0",
        "name": "My First Extension",
        "description": "A sample Visual Studio Services extension",
        "public": false,
        "categories": ["Azure Repos"],
        "targets": [
            {
                "id": "Microsoft.VisualStudio.Services"
            }
        ],
        "contributions": [
            {
                "id": "my-hub",
                "type": "ms.vss-web.hub",
                "targets": [
                    "ms.vss-code-web.code-hub-group"
                ],
                "properties": {
                    "name": "My Hub",
                    "uri": "my-hub.html"
                }
            }
        ],
        "files": [
            {
                "path": "my-hub.html",
                "addressable": true
            },
            {
                "path": "node_modules/azure-devops-extension-sdk",
                "addressable": true,
                "packagePath": "lib"
            }
        ]
    }
    

    Примечание.

    Свойство public определяет, отображается ли расширение всем пользователям в Visual Studio Marketplace. Сохраняйте закрытые расширения во время разработки.

  5. Создайте файл с именем my-hub.html в корневом каталоге расширения со следующим содержимым, который предназначен для представления (также известного как концентратор) в веб-интерфейсе.

    <!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"></script>
        <script>
            window.requirejs.config({
                enforceDefine: true,
                paths: {
                    'SDK': './lib/SDK.min'
                }
            });
            window.requirejs(['SDK'], function (SDK) {
                if (typeof SDK !== 'undefined') {
                    console.log("SDK is defined. Trying to initialize...");
                    SDK.init();
                    SDK.ready().then(() => {
                        console.log("SDK is ready");
                        document.getElementById("name").innerText = SDK.getUser().displayName;
                    });
                } else {
                    console.log('SDK is not defined');
                }
            });
        </script>
        <style>
            body {
                background-color: rgb(0, 67, 117);
                color: white;
                margin: 10px;    
                font-family: "Segoe UI VSS (Regular)","-apple-system",BlinkMacSystemFont,"Segoe UI",sans-serif;
            }
        </style>
    </head>
    <body>        
        <h1>Hello, <span id="name"></span></h1>
    </body>
    </html>
    
  6. Каталог расширений должен выглядеть следующим образом.

    |-- my-hub.html
    |-- node_modules
        |-- @types
        |-- azure-devops-extension-sdk
    |-- package.json
    |-- vss-extension.json
    
Нужна помощь? Задавайте вопросы в Сообщество разработчиков Azure DevOps Services.

Следующие шаги