You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE/ticket-add-frontmatter-to-release-notes.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,13 @@ GH ticket id: #7580
12
12
13
13
## Description
14
14
15
-
To improve the structure and utility of the locally synchronized release notes, we should add YAML frontmatter containing key metadata, similar to how issues are handled.
15
+
To improve the structure and utility of the locally synchronized release notes, we should add YAML frontmatter containing key metadata. This change also standardizes the frontmatter convention across the entire sync service.
16
+
17
+
During implementation, a broader strategic decision was made to align all frontmatter keys with the `camelCase` format used by the source GitHub API (`gh` CLI). This improves maintainability and reduces transformation logic.
16
18
17
19
## Acceptance Criteria
18
20
19
-
1. The `#syncReleaseNotes` method in `SyncService.mjs` is updated to fetch `tagName`, `name`, and `publishedAt`in addition to the release `body`.
20
-
2. The `gray-matter` library is used to stringify the release `body` with the fetched metadata as YAML frontmatter.
21
-
3. The complete content (frontmatter + body) is saved to the local `.md` file.
22
-
4. The filename convention is clarified and implemented to be clean and predictable (e.g., `v10.9.0.md` from a `v10.9.0` tag).
21
+
1. The `#syncReleaseNotes` method in `SyncService.mjs` is updated to fetch `tagName`, `name`, and `publishedAt`and save them as `camelCase` YAML frontmatter.
22
+
2. The `#formatIssueMarkdown` method is refactored to use `camelCase` for all its frontmatter keys (e.g., `createdAt`, `commentsCount`) instead of `snake_case`, ensuring consistency.
23
+
3. The `gray-matter` library is used to stringify the content with the fetched metadata as YAML frontmatter for both issues and release notes.
24
+
4. The filename convention for release notes is confirmed to be clean and predictable (e.g., `v10.9.0.md` from a `v10.9.0` tag).
0 commit comments