Closed Bug 1588542 Opened 7 years ago Closed 6 years ago

Make sure glean_parser always generate reproducible docs

Categories

(Data Platform and Tools :: Glean: SDK, defect, P1)

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: Dexter, Assigned: brizental)

Details

(Whiteboard: [telemetry:glean-rs:m11])

Attachments

(1 file)

Looking at this PR it seems that different runs of the glean_parser to generate markdown give different ordering for labels.

This might produce doc changes that are not needed, because no labels were changed.

Priority: -- → P3
Whiteboard: [telemetry:glean-rs:m?]
Assignee: nobody → brizental
Priority: P3 → P1
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:m11]

I did some investigating here, and this is hapenning because we implement the labes as python sets, which are inherently unordered.

I could just switch to lists, but then we would lose set's hability to just remove duplicates.

I wonder if we could just check for duplicate labels during the linting of metrics.yaml instead and then I can just change the labels to a list.

Attached file GitHub Pull Request —
Status: NEW → RESOLVED
Closed: 6 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: