Skip to content

GitLab Next

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
delivery
delivery
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 355
    • Issues 355
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Requirements
    • Requirements
    • List
  • Operations
    • Operations
    • Incidents
  • Analytics
    • Analytics
    • Insights
    • Issue
    • Value Stream
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Create a new issue
  • Issue Boards
  • GitLab.com
  • GitLab Infrastructure Team
  • deliverydelivery
  • Issues
  • #1370

Closed
Open
Opened Nov 24, 2020 by Yorick Peterse@yorickpeterseMaintainer

Create class for creating/updating Markdown changelog files

Where #1369 talks about writing a parser of our changelog format, we also need a generator to turn the parsed data back into Markdown.

This generator takes the parser output, which may have been modified to contain new version information, and serialised it back to Markdown. The generator should produce output in the same order as the input, ensuring that an unchanged changelog won't result in different output when parsed and serialised back to Markdown.

Entries may be grouped in a section (Fixed, Added, etc), or may not belong to a section. If at least one section is present, uncategorised commits go in the "Other changes" section. If no sections are present, we simply display the entries directly (aka without a "Other changes" title preceding the list of changes).

Edited Nov 24, 2020 by Yorick Peterse
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: gitlab-com/gl-infra/delivery#1370