Skip to content

Add release notes YAML #19

Open
Open
@Fernando-A-Rocha

Description

@Fernando-A-Rocha

There is a page that shows the release notes for every major MTA version. Every major version has had release notes published on the wiki (e.g. last release https://wiki.multitheftauto.com/wiki/Changes_in_1.6 and current release WIP https://wiki.multitheftauto.com/wiki/Changes_in_1.6.1).

This is not the same as the News post or Release on GitHub that contain more user friendly text and other content intended for the public.

I believe that the release notes could be generated by YAML structure containing the various changes labeled properly, like deprecations, notable changes, new features, updates, etc. All properly categorized. It should also contain additional sections for notes like Important information etc.

Example files:

  • "release_notes/1.6.1/new_features.yaml"
  • "release_notes/1.6.1/vendor_updates.yaml"

Imo it's better to use different files because the changelogs are huge.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions