Робочі процеси CI
Робочі процеси GitHub Actions, які автоматизують перевірку PR, додавання міток та інші процеси CI/CD.
Збірка
Робочі процеси CI/CD, як збирати цей сайт та як виконувати різні завдання з обслуговування сайту.
Цей розділ містить документацію, що описує робочі процеси CI/CD, скрипти NPM, і допоміжні скрипти, які використовуються для збирання сайту OpenTelemetry та для його обслуговування.
Типи збірки: повна та скорочена
На додачу до повної (звичайної) збірки сайту Hugo, Docsy підтримує скорочені збірки, які, серед іншого, дозволяють набагато швидше перевіряти посилання, зберігаючи повне покриття перевірки. Детальніше дивіться Chrome build modes у документації Docsy.
Деякі npm-скрипти збірки завжди будують той самий тип сайту (повний або скорочений). Інші використовують значення змінної середовища BUILD_KIND і зазвичай мають значення lean, якщо вона не встановлена.
| Скрипт | Тип збірки | Drafts/future | Мініфікація |
|---|---|---|---|
build | BUILD_KIND | так | ні |
build:full | full | так | ні |
build:lean | lean | так | ні |
build:preview | full | так | так |
build:production | full | ні | так |
log:build (артефакт CI) | BUILD_KIND | так | ні |
netlify-build:preview | full | так | так |
netlify-build:production | full | ні | так |
| Більшість інших команд | BUILD_KIND | так | ні |
Більшість перевірок, які спочатку виконують чисту збірку, наприклад перевірка посилань, використовують BUILD_KIND. Детальніше про скрипти перевірки посилань дивіться в Перевірка посилань.
Якщо вам цікавий розмір та продуктивність різних типів збірки, виконайте npm run metrics:build (повна) або npm run metrics:build -- --lean.
Перевірка посилань
Як перевіряються посилання сайту — локально та в CI.
Патчі вмісту модулів
Створення та керування тимчасовими патчами для модулів вмісту між релізами.
Скрипти NPM
Скрипти NPM для побудови, обслуговування, перевірки та підтримки вебсайту OpenTelemetry.
Допоміжні скрипти
Скрипти Shell, що використовуються в робочих процесах CI та локальній розробці для управління мітками, перевірки посилань, оновлення реєстру тощо.
Автоматизація компонентів колектора
Пояснення процесу автоматизації для компонентів OpenTelemetry Collector.
Налаштування нової локалізації
Покроковий посібник для підтримки нової локалізації мови на вебсайті OpenTelemetry.
Анонси на головній сторінці
Поля front matter та поведінка рендерингу для сторінок анонсів на головній сторінці.