This project generates a static webapp (for GitHub Pages) that allows users to compare release/upgrade notes for opentelemetry-collector and opentelemetry-collector-contrib between versions, filter by component, and see only relevant upgrade notes.
✨ As seen on o11y-news 2025-09-29! ✨
- Go code fetches/parses release notes from GitHub.
- Generates static HTML/JS/CSS and JSON data for the frontend.
- Output is placed in
docs/for GitHub Pages hosting.
- Run
go run ./cmd/generateto generate the static site. - Commit and push the
docs/directory to your repository. - Enable GitHub Pages for the
docs/directory. - A GitHub workflow will update the release notes daily.
To preview the static website locally:
go run ./cmd/generate
go run ./cmd/serveThis project is ready to deploy as a static site using GitHub Pages.
-
Enable GitHub Pages
Go to your repository’s Settings → Pages.
Set the source branch tomain(or your default branch) and the folder to/docs. -
Automatic Updates
A GitHub Actions workflow (.github/workflows/generate-release-notes.yml) is included.
It will:- Re-generate the static site every day at 03:00 UTC (or on manual dispatch).
- Deploy the updated site to GitHub Pages automatically.
-
Manual Generation (optional)
You can still run locally:go run ./cmd/generate go run ./cmd/serve
-
Visit your site
After the workflow runs your site will be available at:
https://<your-username>.github.io/<your-repo>/
- Compare release/upgrade notes for opentelemetry-collector and opentelemetry-collector-contrib between any two versions.
- Filter by one or more components (multi-select supported).
- Fuzzy search for components to quickly find what you need.
- Shareable URLs: copy the link to share your exact comparison (project, versions, components).
- Highlights breaking changes (🚨) and bugfixes (🐞).
- Typos in component names are auto-corrected.
- Clean, modern, responsive UI.