Skip to content

Fix inverted changelog area key/title mapping - #1139

Closed
phlax with Copilot wants to merge 3 commits into
envoy.code.check-changelogsfrom
copilot/envoycodecheck-changelogs
Closed

phlax with Copilot wants to merge 3 commits into
envoy.code.check-changelogsfrom
copilot/envoycodecheck-changelogs

Conversation

Copilot AI commented Sep 11, 2026

Copy link
Copy Markdown

The changelog checker and parser were treating / as the canonical area key and decoding ~ from entry filenames before lookup. Envoy’s changelog config does the opposite: keys are filename-safe ids using ~, titles are display strings using /, and filenames use the key verbatim.

  • Checker: restore canonical key handling

    • Accept ~ in area keys and reject / in keys.
    • Accept / in titles and reject ~ in titles via title validation.
    • Validate entry filename areas against the key regex and look them up directly in self.areas.
    • Remove the inverted checks that treated ~ as filename-only escaping and required slash keys to carry special title handling.
  • Base utils: preserve entry area keys

    • Revert filename-area decoding in data_from_entry_map.
    • Remove the AREA_SEPARATOR / AREA_FILENAME_SEPARATOR helpers and conversion functions added for the inverted model.
  • Docs and tests

    • Rewrite the README section to describe the actual contract:
      • YAML keys use ~
      • titles use /
      • entry filenames use the key unchanged
    • Update tests to cover valid dns~cares keys, invalid dns/cares keys, invalid dns~cares titles, direct filename-key matching, and unchanged parsed entry areas.
areas:
  dns~cares:
    title: dns/cares
changelogs/current/new_features/dns~cares__preserve-qid.rst

Copilot AI and others added 2 commits September 11, 2026 12:22
Co-authored-by: phlax <454682+phlax@users.noreply.github.com>
Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: phlax <454682+phlax@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix inverted changelog area-key/title mapping issue Fix inverted changelog area key/title mapping Sep 11, 2026
Copilot AI requested a review from phlax September 11, 2026 12:00
@phlax
phlax force-pushed the envoy.code.check-changelogs branch from a047f31 to 5450f31 Compare September 11, 2026 13:02
@phlax phlax closed this Sep 11, 2026
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