docs: added documentation which explains why blindly upgrading otel dependencies might introduce bugs with xk6-modules

[wim07101993]

Which Problems Are Solved

Upgrading otel dependencies would sometimes break xk6-modules of our load tests.

How the Problems Are Solved

• Added documentation which describes how to check for compatibility
• Added a script and step in ci which check for compatibility

Additional Changes

Additional Context

[Copilot]

Pull request overview

This PR documents and enforces a constraint around OpenTelemetry dependency upgrades to prevent breaking downstream zitadel/xk6-modules builds that depend on both this library and grafana/k6.

Changes:

• Added contributor documentation describing why OpenTelemetry upgrades must not get ahead of the latest tagged k6 release, and how to verify compatibility.
• Added a GitHub Actions workflow to enforce the “otel not ahead of k6” rule on PRs and key branches.
• Added a bash script that compares this repo’s go.opentelemetry.io/otel* requirements with those pinned by the latest k6 release on the major line used by xk6-modules.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
CONTRIBUTING.md	Adds guidance and verification steps for safe OpenTelemetry dependency bumps (k6/xk6-modules compatibility).
.github/workflows/otel-k6-compat.yml	Introduces CI enforcement to fail PRs that upgrade otel beyond the latest tagged k6 release.
.github/scripts/check-otel-k6-compat.sh	Implements the compatibility check by resolving the relevant k6 tag and comparing pinned otel versions.

Suppressed comments (1)

.github/scripts/check-otel-k6-compat.sh:56

• Same as above: add curl retries/timeouts to reduce CI flakiness when fetching k6's go.mod from raw.githubusercontent.com.

theirs=$(curl -sSfL "$(printf "$K6_GOMOD_URL" "$k6_tag")" | otel_versions | head -1)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.