Skip to content

ci: the release PR scope check accepts metadata without an observability version example - #792

Merged
szibis merged 1 commit into
mainfrom
ci/release-pr-scope-observability
Oct 21, 2026
Merged

szibis merged 1 commit into
mainfrom
ci/release-pr-scope-observability

Conversation

@szibis

@szibis szibis commented Oct 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

The first bot-opened metadata pull request (#791, v2.24.0) failed release-pr-scope with docs/observability.md service.version example is not 2.24.0. docs/observability.md has had no "service.version" example since #109, so sync_release_metadata.sh's substitution for it changes nothing and the check (carried over from the old dispatch-only validation) could never pass. #791 itself is correct: it changes only CHANGELOG.md and charts/loki-vl-proxy/Chart.yaml, one GitHub-verified commit.

Change

.github/workflows/release-pr-validation.yaml: the observability check runs only when docs/observability.md at the pull request's head contains a "service.version" key; when it does, the first entry must equal the release version (a key without a string value fails). The Chart.yaml and CHANGELOG checks stay unconditional (the sync script always rewrites them). sync_release_metadata.sh is unchanged.

Proofs

scripts/ci/tests/test_release_pr_validation.py: 4 new cases, 77 script tests pass — no example passes; a stale example fails; a key without a value fails; an exact replay of #791 (CHANGELOG + Chart.yaml, verified commit, no example) passes. actionlint (pinned and local), zizmor 1.30.1 (pinned, no findings), conformance and changelog gates.

Merge after #791: a push to main before #791's release metadata merges would make the release bot cut a duplicate release. After this lands, re-running release-pr-scope on any open metadata PR passes.

Follow-up, not in this change: the dead service.version substitution in scripts/ci/sync_release_metadata.sh.

@github-actions github-actions Bot added size/S Small change scope/ci CI/CD scope/docs Documentation maintenance Maintenance labels Oct 21, 2026
@szibis
szibis merged commit 7160642 into main Oct 21, 2026
34 checks passed
@szibis
szibis deleted the ci/release-pr-scope-observability branch October 21, 2026 15:19
@github-actions

Copy link
Copy Markdown
Contributor

PR Quality Report

Compared against base branch main.

Coverage and tests

Signal Base PR Delta
Test count 11763 11763 0
Coverage 88.3% 88.3% 0.0% (stable)

Compatibility

Track Base PR Delta
Loki API 100.0% 11/11 (100.0%) 0.0% (stable)
Logs Drilldown 100.0% 17/17 (100.0%) 0.0% (stable)
VictoriaLogs 100.0% 11/11 (100.0%) 0.0% (stable)

Performance smoke

Performance smoke was skipped for this PR because no perf-sensitive paths changed.

State

  • Coverage, compatibility, and sampled performance are reported here from the same PR workflow.
  • This is a delta report, not a release gate by itself. Required checks still decide merge safety.
  • Performance smoke was intentionally skipped because no perf-sensitive paths changed in this PR.
  • Delta states use the same noise guards as the quality gate (percent + absolute + low-baseline checks), so report labels match merge-gate behavior.

szibis added a commit that referenced this pull request Oct 21, 2026
…ased (#793)

#792 merged before the v2.24.0 metadata pull request (#791), and the
squash merge of #791 placed #792's entry inside the released 2.24.0
section, which v2.24.0 never contained. Restore 2.24.0 to what the release
published and list the entry under Unreleased, where the next release
picks it up.

Co-authored-by: szibis <szibis@users.noreply.github.com>
szibis added a commit that referenced this pull request Oct 21, 2026
The release workflow could not create the metadata branch for v2.24.1
(it was cut from #794 while main had already moved on). Materialize the
published 2.24.1 notes as the [2.24.1] section (#792's CI entry and
#794's Security entry, exactly as released) and set the chart to 2.24.1;
[Unreleased] keeps the entries merged since (#795, #796, #797).

Co-authored-by: szibis <szibis@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Maintenance scope/ci CI/CD scope/docs Documentation size/S Small change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant