Створення нової збірки Azure DevOps і оновлення її змінних за допомогою REST API.
Azure DevOps — це повний набір інструментів і служб розробки, призначених для того, щоб допомогти командам швидше й ефективніше створювати та надсилати програмне забезпечення. Однією з ключових особливостей Azure DevOps є його система збірки, що дозволяє командам автоматизувати збірку, тест, і процес розгортання програмного забезпечення.
У цій статті, ми розглянемо, як створити нову збірку Azure DevOps і оновити її змінні за допомогою REST API. Ми використаємо зразок коду, який демонструє, як створити нову збірку за допомогою cURL, але ви можете використовувати будь-яку мову програмування, яка підтримує виклики REST API.
Першим кроком у створенні нової збірки Azure DevOps є визначення її властивостей, наприклад, визначення побудови та параметри побудови. Визначення побудови визначає кроки побудови, які можуть включати такі завдання, як компіляція коду, ходові тести, і створення артефактів. Параметри побудови — це змінні, які використовуються етапами побудови для налаштування процесу побудови.
Щоб створити нову збірку за допомогою REST API, вам потрібно надіслати запит POST на адресу Кінцева точка Azure DevOps API, яка створює збірки. Наступний фрагмент коду демонструє, як створити нову збірку за допомогою cURL:
curl -X POST "https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.0" \
-H "Content-Type: application/json" \
-d '{
"definition": {
"id": {definition_id}
},
"parameters": "{\"{parameter_name}\":\"{parameter_value}\"}"
}'
Приклад роботи з PAT:
curl -X POST "https://{username}:{PAT}@dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.0" \
-H "Content-Type: application/json" \
-d '{
"definition": {
"id": {definition_id}
},
"parameters": "{\"{parameter_name}\":\"{parameter_value}\"}"
}'
Давайте розберемо цей фрагмент коду:
- The
-X POST
прапорець вказує, що ми хочемо надіслати запит POST. - Кінцевою точкою API для створення збірок є https://dev.azure.com/{організації}/{демонструвати}/_apis/build/builds?api-версія=7.0, де {організації} це ваше ім'я Azure DevOps організація і {демонструвати} це назва вашого проекту. The
api-version
Параметр визначає версію API, яку ми хочемо використовувати. - The
-H "Content-Type: application/json"
прапорець вказує, що ми надсилаємо дані JSON у тілі запиту. - Тіло запиту — це об’єкт JSON, який містить такі властивості:
definition
: об'єкт, який визначає визначення збірки. Theid
властивість визначає ідентифікатор визначення збірки.parameters
: рядок у форматі JSON, який визначає параметри збірки. The{parameter_name}
і{parameter_value}
заповнювачі слід замінити фактичною назвою та значенням параметра, відповідно.
У прикладі фрагмент коду, ми створюємо нову збірку, використовуючи визначення збірки з ідентифікатором 15 та його оновлення NUMBER_OF_WORKERS
параметр зі значенням змінної 2_NUMBER_OF_WORKERS
, яке можна замінити на фактичне значення під час виконання. Ми також встановлюємо NUMBER_OF_WORKERS2
параметр до статичного значення 5.
Щоб оновити змінну збірки за допомогою REST API, вам потрібно надіслати запит PATCH до кінцевої точки API, яка оновлює змінні збірки. Наступний фрагмент коду демонструє, як оновити змінну збірки за допомогою cURL:
curl -X PATCH "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{build_id}/variables?api-version=7.0" \
-H "Content-Type: application/json" \
-d '{
"variables": {
"{variable_name}": {
"value": "{new_value}"
}
}
}'
Давайте розберемо цей фрагмент коду:
- The
-X PATCH
прапорець вказує, що ми хочемо надіслати запит PATCH. - Кінцевою точкою API для оновлення змінних збірки є `https://dev.azure.com/{організації}/{демонструвати}/_apis/build/builds/{build_id}/змінні?api-версія=7.0