CI workflows
GitHub Actions workflows that automate PR checks, label management, and other CI/CD processes.
Build
CI/CD workflows, how to build this site, and how to perform various site maintenance activities
This section documents the CI/CD workflows, NPM scripts, and helper scripts that power the OpenTelemetry website’s build, deployment, and maintenance processes.
Build kinds: full and lean
In addition to full (regular) Hugo website builds, Docsy supports lean builds that, among other things, allow for much faster link checking while still maintaining full check coverage. For details, see Link checking in the Docsy docs.
Some build npm scripts always build the same kind of site (full or lean). Others
use the value of the BUILD_KIND environment variable and default to lean
when unset.
| Script | Build kind | Drafts/future | Minify |
|---|---|---|---|
build | BUILD_KIND | yes | no |
build:full | full | yes | no |
build:lean | lean | yes | no |
build:preview | full | yes | yes |
build:production | full | no | yes |
log:build (CI artifact) | BUILD_KIND | yes | no |
netlify-build:preview | full | yes | yes |
netlify-build:production | full | no | yes |
| Most other commands | BUILD_KIND | yes | no |
Most checks that force a fresh build first, such as link-checking, use
BUILD_KIND. For details about the link checking scripts, see
Link checking.
If you’re curious about the size and performance of the different build kinds,
run npm run metrics:build (full) or npm run metrics:build -- --lean.
Link checking
How the site’s links are checked, locally and in CI.
Content module patches
Creating and managing temporary patches for content modules between releases.
NPM scripts
NPM scripts for building, serving, validating, and maintaining the OpenTelemetry website.
Helper scripts
Shell scripts used by CI workflows and local development for label management, link checking, registry updates, and more.
Collector Component Automation
Explanation of the automation process for OpenTelemetry Collector components.
Setting up a new localization
Step-by-step maintainer guide for onboarding a new language localization to the OpenTelemetry website.
Homepage announcements
Front matter fields and rendering behavior for homepage announcement pages.