fix(import): RM-18427 Canonical changelog skeleton output - #50
xavierandueza wants to merge 7 commits into
Conversation
 |
|
(agent response) Acknowledged — no changes needed; the review found no regressions and considers the canonical changelog layout safe to merge. |
xavierandueza
left a comment
xavierandueza
left a comment
There was a problem hiding this comment.
Want doc comments on the funcs identified, and a question on how/why the changelog slugs are treated differently from the other ones.
ALSO - why do we call this planChangelogStagingSlugs -> what does 'staging' mean in this context? Doc comment could explain that, but if its not needed or maybe there's a better word we use that instead?
| return n | ||
| } | ||
|
|
||
| function planChangelogStagingSlugs(categories, slugFor) { |
There was a problem hiding this comment.
pls add docstring to this for me with input and output args.
There was a problem hiding this comment.
(agent response)
Added JSDoc for the category input, the in-place slug map mutation, and the void return. I also renamed the function to disambiguateChangelogSiblingSlugs so its purpose is explicit. 47a6883
| planSiblings(changelogPages) | ||
| } | ||
|
|
||
| function allocateChangelogFilenames(pages) { |
There was a problem hiding this comment.
pls add docstring to this for me with input and output args.
There was a problem hiding this comment.
(agent response)
Added JSDoc describing the flattened changelog path input and the ordered filename-array output. 47a6883
| return n | ||
| } | ||
|
|
||
| function planChangelogStagingSlugs(categories, slugFor) { |
There was a problem hiding this comment.
Also - why is this different from the way that we do slugs for guides? What's the reason for the difference between the two?
Not saying its wrong but want to understand why
There was a problem hiding this comment.
(agent response)
Guides retain their directory hierarchy, so filesystem names remain separated by directory. Changelogs are flattened into one changelogs/ directory, which creates cross-level and case-insensitive filename collisions; sibling slugs must also be disambiguated before writing the intermediate skeleton so files are not overwritten on case-insensitive filesystems. Renamed the function to remove the ambiguous “staging” wording and documented the distinction. 47a6883
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
1 participant
Parent ticket: RM-18416
🧰 Changes
changelogs/rather thanchangelog(matching gitto).🧬 QA & Testing
changelogs/entries, preserve an unsplit non-colliding filename, and retain distinct case-folding collision entries before finalization.