-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Closed
Labels
squad:platformIssue to be handled by the Platform team.Issue to be handled by the Platform team.type:taskThis issue reports a chore (non-production change) and other types of "todos".This issue reports a chore (non-production change) and other types of "todos".
Milestone
Description
Task description
It's time to roll out the new changelog generator in this repository, as the new solution is ready to use (#18051).
See: https://github.com/ckeditor/ckeditor5-dev/releases/tag/v50.1.0.
Definition of Done
Caution
To avoid converting git commits to changelog entries (Markdown files), the related pull request must be merged right after starting the upcoming testing phase (iteration 87).
- Add a script to create a new changelog entry (
nice
, New Individual Changelog Entry)."nice": "ckeditor5-dev-changelog-create-entry"
- It applies to both repositories: CKEditor 5 and Commercial.
- Redesign (and rename:
release:prepare-changelog
) the changelog generator to use theckeditor5-dev-changelog
package. It should accept two flags:--date
- an optional modifier that defines a release day.--dry-run
- an optional modifier that displays the changelog instead of saving it into theCHANGELOG.md
file.
- Rewrite a pull request template to avoid mentioning the old convention.
- 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.
- It applies to both repositories: CKEditor 5 and Commercial.
- Review and update README.
- Rewrite the section regarding the changelog preparation.
- Commercial: redesign the nightly release process to generate the changelog using the new format.
- Rewrite the Git commit message convention guide.
Technical details
No response.
Other details
- An example PR introducing the same change in
ckeditor5-dev
: Integrate the new changelog tool in the repository ckeditor5-dev#1149
Metadata
Metadata
Assignees
Labels
squad:platformIssue to be handled by the Platform team.Issue to be handled by the Platform team.type:taskThis issue reports a chore (non-production change) and other types of "todos".This issue reports a chore (non-production change) and other types of "todos".