-
Notifications
You must be signed in to change notification settings - Fork 1.3k
fix(changelog): convert markdown headers to bold text for proper formatting #532
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…atting Changeset descriptions that use markdown headers (### New Features) get nested inside list items, causing poor rendering. This converts all affected entries to use **Bold Text** instead, which renders correctly. Also adds a brief summary line to each entry for better readability.
📝 WalkthroughWalkthroughCHANGELOG.md undergoes structural reorganization where explicit "### New Features" headings are replaced with inline bullet-style entries describing features like project-level configuration, project-local schemas, and schema management commands across multiple version sections (0.22.0, 0.21.0, 0.20.0, 0.19.0). Formatting and surrounding headers are adjusted for consistency. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Review CompleteYour review story is ready! Comment !reviewfast on this PR to re-generate the story. |
Greptile SummaryFixes changelog rendering by replacing markdown headers with bold text formatting in list item contexts. Changes Made:
Bug Fixes`, `Other`, and `Documentation` headers to `**Bold Text**` format in 6 affected changelog entries (versions 0.22.0, 0.21.0, 0.20.0, 0.19.0, and 0.17.0)- Added concise summary lines immediately after PR links for better readability (e.g., "Add project-level configuration, project-local schemas, and schema management commands") - Preserved all content and list structure, only changing header formattingWhy This Matters: Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Author
participant Changesets
participant GitHub
participant Reader
Author->>CHANGELOG.md: Write markdown headers (### New Features)
Note over CHANGELOG.md: Headers nested in list items
Changesets->>CHANGELOG.md: Format as list item continuation
CHANGELOG.md->>GitHub: Render markdown
GitHub->>Reader: Display incorrectly nested headers
Note over Author,Reader: FIX APPLIED
Author->>CHANGELOG.md: Replace ### with **Bold**
Author->>CHANGELOG.md: Add summary lines
CHANGELOG.md->>GitHub: Render markdown
GitHub->>Reader: Display properly formatted bold text
|
…atting (Fission-AI#532) Changeset descriptions that use markdown headers (### New Features) get nested inside list items, causing poor rendering. This converts all affected entries to use **Bold Text** instead, which renders correctly. Also adds a brief summary line to each entry for better readability.
# By Tabish Bidiwale (57) and others # Via GitHub * main: (67 commits) fix(ci): use workflow_dispatch for polish release notes (Fission-AI#533) fix(changelog): convert markdown headers to bold text for proper formatting (Fission-AI#532) Version Packages (Fission-AI#531) Add changeset for project config and schema commands (Fission-AI#530) fix(config): handle null rules field in project config (Fission-AI#529) docs: update workflow docs and mark schema commands as experimental (Fission-AI#526) feat(cli): add schema management commands (Fission-AI#525) fix: Windows path compatibility in resolver tests (Fission-AI#524) change(schema-management-cli): proposal for schema management commands (Fission-AI#523) feat(resolver): add project-local schema support (Fission-AI#522) docs: add project-config demo guide (Fission-AI#521) feat(config): add project-level configuration via openspec/config.yaml (Fission-AI#499) fix: auto-trigger polish release notes on release publish (Fission-AI#519) perf: add path filtering to Nix validation CI job (Fission-AI#518) Version Packages (Fission-AI#517) Add changeset for v0.21 release (Fission-AI#516) fix: prevent implementation during explore mode (Fission-AI#515) OPSX apply: infer target change (Fission-AI#513) Refine opsx archive sync assessment (Fission-AI#514) feat: add nix flake support (sorry for this duplicate) (Fission-AI#459) ... # Conflicts: # src/core/templates/slash-command-templates.ts
Summary
### New Features) were nested inside list items**Bold Text**instead, which renders correctly in the list item contextProblem
Changesets formats descriptions as list item continuations. When descriptions contain markdown headers, they get nested incorrectly:
Solution
Replace
### Headerwith**Header**which renders properly as bold text within the list context.Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.