Skip to content

Implement the new changelog tool in ckeditor5-angular #493

@pomek

Description

@pomek

Task description

It's time to roll out the new changelog generator in this repository, as the new solution is ready to use (ckeditor/ckeditor5#18051).

Definition of Done

  • Upgrade all of the ckeditor5-dev-* packages to their latest version.
    • When writing this, it's v50.1.0. It's enough to match the major version (^50.0.0).
  • Add a script to create a new changelog entry (nice, New Individual Changelog Entry).
    • "nice": "ckeditor5-dev-changelog-create-entry"
  • Redesign (and rename: release:prepare-changelog) the changelog generator to use the ckeditor5-dev-changelog package. It should accept two flags:
    1. --date - an optional modifier that defines a release day.
    2. --dry-run - an optional modifier that displays the changelog instead of saving it into the CHANGELOG.md file.
  • Rewrite a pull request template to avoid mentioning the old convention.
  • If the repository contains commits since the latest release, they must be converted into the new structure.
    • Write a comment including the current status to give the reviewer a clear vision of what to expect.
  • Create the changelog directory and a file that allows tracking it by git, even if it's empty.
    • .changelog/.gitkeep
    • Ensure git tracks changes in this directory.
  • Review and update README.
    • Rename Devops => Platform
    • Rewrite the section regarding the changelog preparation.

Technical details

No response

Other details

Metadata

Metadata

Assignees

Labels

squad:platformIssue to be handled by the Platform team.type:taskThis issue reports a chore (non-production change) and other types of "todos".

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions