Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 12, 2025

Implements Milestone 1 from docs/release/remove-v1-checklist.md: ensure documentation and examples default to v2 images/binaries without breaking CI or release automation.

Changes

Documentation updates

  • CONTRIBUTING.md: Show v2 as primary dev option (go run ./cmd/jaeger --config ./cmd/jaeger/config.yaml), v1 as legacy
  • docker-compose/monitor/README.md: Remove v1 examples, update tracegen to latest, simplify terminology
  • examples/hotrod/README.md: Change examples from all-in-one:latest to jaeger:latest, version from 1.52 to 2.0.0

Verified no changes needed

All CI test scripts and docker-compose files already use v2 by default or accept explicit version parameters:

  • scripts/e2e/{kafka,spm}.sh already default to v2
  • scripts/e2e/{elasticsearch,cassandra}.sh require explicit parameters (CI passes them)
  • docker-compose/*/Makefile build v2 binaries or use explicit version flags
  • examples/otel-demo/deploy-all.sh uses jaegertracing/jaeger:latest

Impact

  • Developers see v2 examples by default
  • CI matrix tests remain unchanged (explicitly pass v1/v2 as needed)
  • v1 compatibility preserved: docker-compose-v1.yml, dev-v1 targets, CI matrix parameters
  • Release automation untouched

Example

Before:

docker run -p16686:16686 jaegertracing/all-in-one:latest

After:

docker run -p16686:16686 jaegertracing/jaeger:latest

Related: #7497

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • cr.jaegertracing.io
    • Triggering command: /usr/libexec/docker/cli-plugins/docker-compose compose up -d (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Goal: Implement Milestone 1 from docs/release/remove-v1-checklist.md by removing default usage of v1 artifacts in convenience Makefiles, example scripts, and CI-invoked test helpers. This is a non-breaking, reversible change: release/publish automation that actually produces v1 artifacts must remain able to do so (no changes to core release scripts that publish artifacts).

Scope (files to modify):

  • docker-compose/tail-sampling/Makefile
    • Replace any default variables that set JAEGER_VERSION to a v1 value with v2 defaults (e.g. JAEGER_VERSION=2.0.0 or use the repo's v2-suffix convention). If the file provides convenience targets that default to v1 images, update them to use v2 or remove v1 convenience targets.
  • docker-compose/monitor/Makefile
    • Update dev convenience targets and README example lines to use v2 images by default.
  • examples/otel-demo/deploy-all.sh
    • If the script defaults to v1 images, change defaults to v2; preserve an explicit legacy flag to deploy v1 if needed.
  • scripts/e2e/* (only test helpers invoked by CI)
    • Identify helper scripts used by CI e2e jobs that default to v1 and change their defaults to v2. Do not alter release/publish scripts.
  • scripts/utils/compare_metrics.py
    • Make v2 metrics the default for compare helpers invoked by CI. Keep ability to compare v1 via explicit flag (no breaking change for test assertions).
  • README/example lines that are invoked by CI or referenced in release docs
    • Update documented example commands to use v2 by default where they would be used by maintainers or CI.
  • Small convenience Makefile targets / scripts referenced in documentation or used by CI tests
    • Replace v1 defaults with v2; remove legacy v1 targets where appropriate.

Implementation details:

  • Keep changes minimal: change default literal values, update example lines, and remove v1-only convenience shortcuts if present.
  • Preserve any explicit support for generating or publishing v1 artifacts in the core release automation (these are out of scope for this PR).
  • Add clear PR description and tests in the PR body listing exactly which files changed and why.
  • Create branch chore/remove-v1-usage (off main) and open a pull request with the changes.

Testing / Validation plan (to include in PR):

  1. Run repository CI (staging) to ensure tests still pass and no CI job pulls v1 images by default.
  2. Run docker-compose examples that were updated (tail-sampling, monitor) locally and confirm default images are v2.
  3. Run examples/otel-demo/deploy-all.sh in dry-run and confirm it will deploy v2 images by default.
  4. Run scripts/e2e tests used by CI and ensure compare_metrics.py defaults to v2 metrics; validate no regressions.
  5. Sanity-check that core release/publish scripts remain unchanged and still compile if used to produce v1 artifacts.

PR metadata:

Please implement the minimal code edits described above, open a PR against main, and include the testing steps in the PR description.

This pull request was created as a result of the following prompt from Copilot chat.

Goal: Implement Milestone 1 from docs/release/remove-v1-checklist.md by removing default usage of v1 artifacts in convenience Makefiles, example scripts, and CI-invoked test helpers. This is a non-breaking, reversible change: release/publish automation that actually produces v1 artifacts must remain able to do so (no changes to core release scripts that publish artifacts).

Scope (files to modify):

  • docker-compose/tail-sampling/Makefile
    • Replace any default variables that set JAEGER_VERSION to a v1 value with v2 defaults (e.g. JAEGER_VERSION=2.0.0 or use the repo's v2-suffix convention). If the file provides convenience targets that default to v1 images, update them to use v2 or remove v1 convenience targets.
  • docker-compose/monitor/Makefile
    • Update dev convenience targets and README example lines to use v2 images by default.
  • examples/otel-demo/deploy-all.sh
    • If the script defaults to v1 images, change defaults to v2; preserve an explicit legacy flag to deploy v1 if needed.
  • scripts/e2e/* (only test helpers invoked by CI)
    • Identify helper scripts used by CI e2e jobs that default to v1 and change their defaults to v2. Do not alter release/publish scripts.
  • scripts/utils/compare_metrics.py
    • Make v2 metrics the default for compare helpers invoked by CI. Keep ability to compare v1 via explicit flag (no breaking change for test assertions).
  • README/example lines that are invoked by CI or referenced in release docs
    • Update documented example commands to use v2 by default where they would be used by maintainers or CI.
  • Small convenience Makefile targets / scripts referenced in documentation or used by CI tests
    • Replace v1 defaults with v2; remove legacy v1 targets where appropriate.

Implementation details:

  • Keep changes minimal: change default literal values, update example lines, and remove v1-only convenience shortcuts if present.
  • Preserve any explicit support for generating or publishing v1 artifacts in the core release automation (these are out of scope for this PR).
  • Add clear PR description and tests in the PR body listing exactly which files changed and why.
  • Create branch chore/remove-v1-usage (off main) and open a pull request with the changes.

Testing / Validation plan (to include in PR):

  1. Run repository CI (staging) to ensure tests still pass and no CI job pulls v1 images by default.
  2. Run docker-compose examples that were updated (tail-sampling, monitor) locally and confirm default images are v2.
  3. Run examples/otel-demo/deploy-all.sh in dry-run and confirm it will deploy v2 images by default.
  4. Run scripts/e2e tests used by CI and ensure compare_metrics.py defaults to v2 metrics; validate no regressions.
  5. Sanity-check that core release/publish scripts remain unchanged and still compile if used to produce v1 artifacts.

PR metadata:

Please implement the minimal code edits described above, open a PR against main, and include the testing steps in the PR description.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Remove default usage of v1 artifacts in Makefiles and scripts Milestone 1: Update documentation defaults from v1 to v2 Nov 12, 2025
Copilot AI requested a review from yurishkuro November 12, 2025 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants