Skip to content

Releases: ckeditor/ckeditor5-dev

v23.2.0

20 Aug 11:50
Compare
Choose a tag to compare

Features

  • jsdoc-plugins: Introduced a plugin that hides the package documentation if in the package's package.json file the private key is set to true. However, by adding the @publicApi annotation, you can mark blocks of the code that should not be hidden. (commit)
  • tests: Manual test server accepts a new flag: --identity-file (alias: -i) that allows defining global constants in manual tests. (commit)

Other changes

  • env: Improved output displayed while the translations.upload() function is working. Instead of displaying console.log() after each package, summary tables will be displayed when the function finishes its job. (commit)
  • tests: Manual test script will not search for tests in the ./manual/_utils directory. If any of a manual test requires additional utils to work, those can be placed in the _utils directory. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

v23.1.1

05 Aug 12:34
Compare
Choose a tag to compare

Internal changes only (updated dependencies, documentation, etc.).

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

v23.1.0

03 Aug 10:08
Compare
Choose a tag to compare

Features

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

v23.0.0

22 Jul 09:23
Compare
Choose a tag to compare

MAJOR BREAKING CHANGES ℹ️

  • jsdoc-plugins: Functions documented in a module will no longer be documented as static functions. Therefore links to functions will not contain the static- part and links created in the past will no longer work.

Features

  • jsdoc-plugins: Updated JSDoc and align custom JSDoc plugins. Part of ckeditor/ckeditor5#7575. (commit)

    • Improved performance,
    • Fixed incorrectly and inconsistently documented functions. Previously they were marked as static/instance using the . or # symbols. Now they are documented the same as classes, interfaces, and mixins using the ~ symbol. (e.g. module:widget/utils~toWidget),
    • Validator was improved, now it detects duplicated modules and previously hidden mistakes.
    • Updated JSDoc allows for modern JS syntax, async/await among others.

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Major releases (contain major breaking changes):

Other releases:

v22.0.0

20 Jul 13:00
Compare
Choose a tag to compare

MAJOR BREAKING CHANGES ℹ️

  • env: Task generateChangelogForMonoRepository() will generate the changelog uses the same version for all packages.

Features

Bug fixes

  • env: The getCommit() util will return a proper array with commits if the release branch in the project is other than master. Due to --first-parent flag which is used for collecting the commits, when the release branch is other than master, commits made on master could not be collected directly from the branch. Now those commits are collected in two ranges: from the last tag to the base commit and from the base commit to HEAD and merged together. Closes ckeditor/ckeditor5#7492. (commit)
  • env: Scoped breaking changes notes won't be duplicated in the changelog. Closes ckeditor/ckeditor5#7495. (commit)
  • env: Commit and note groups should be sorted properly. Closes ckeditor/ckeditor5#7496. (commit)

Other changes

  • env: The generateChangelogForMonoRepository() task supports options.releaseBranch that is passed directly to the getCommit() util. See ckeditor/ckeditor5#7492. (commit)
  • env: The changelog generator for mono repository will use the same version for all packages. On the screen, a user will see all changes: MAJOR BREAKING CHANGES, MINOR BREAKING CHANGES, and all commits since the last release. The user must review it and provide the version. Closes ckeditor/ckeditor5#7323. (commit)
  • env: Merge commits between stable/release/master branches will be ignored when generating the changelog, to reduce the noise. Closes ckeditor/ckeditor5#7489. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Major releases (contain major breaking changes):

Releases containing new features:

Other releases:

v21.0.0

22 Jun 08:02
Compare
Choose a tag to compare

MAJOR BREAKING CHANGES ℹ️

  • Minimal version of Node.js for all packages included in the repository has been increased to 12.0.0.

Features

Bug fixes

  • When typed "skip" as a new version, the changelog generator should abort the process instead of writing invalid entries to the changelog file. Closes ckeditor/ckeditor5#7402. (commit)

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Major releases (contain major breaking changes):

v20.2.1

01 Jun 09:33
Compare
Choose a tag to compare

Internal changes only (updated dependencies, documentation, etc.).

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

v20.2.0

01 Jun 07:33
Compare
Choose a tag to compare

Features

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

v20.1.0

27 May 07:05
Compare
Choose a tag to compare

Features

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

v20.0.0

22 May 07:59
Compare
Choose a tag to compare

MAJOR BREAKING CHANGES ℹ️

  • env: Removed generateChangelogForSubPackages() task. Use generateChangelogForMonoRepository() instead.
  • env: Removed generateChangelogForSubRepositories() task. Use generateChangelogForMonoRepository() instead if your repository is a monorepository.
  • env: Removed generateSummaryChangelog() task.
  • env: CKEditor 5 release tools now are designed to work with monorepo architecture.
  • env: Following binary commands were removed:
    • ckeditor5-dev-tests-travis
    • ckeditor5-dev-tests-prepare-mrgit-json
    • ckeditor5-dev-tests-prepare-package-json
    • ckeditor5-dev-tests-install-dependencies
    • ckeditor5-dev-tests-save-revision

MINOR BREAKING CHANGES ℹ️

  • env: Removed support for the NOTE type of commit's notes.
  • env: Removed hasMajorBreakingChanges() and hasMinorBreakingChanges() utils from /lib/release-tools/utils/changelog.js helper.
  • env: Removed the getNewReleaseType() util. Use getCommits() and getNewVersionType() instead.
  • env: Removed getSubPackagesPaths() util.
  • env: Renamed getSubRepositoriesPaths() util to getPackagesPaths().
  • env: The util getPackagesPaths() does not check whether packages are defined as dependencies in package.json in the main repository.
  • env: Task generateChangelogForSinglePackage() does not accept options: newVersion, disableMajorBump, isInternalRelease, indentLevel, useExplicitBreakingChangeGroups anymore. The task should be used for generating the changelog for the single repository.
  • env: Moved all utils from /lib/release-tools/utils/transform-commit to /lib/release-tools/utils.

Features

  • env: Support for multi-entries messages in the single commit and scoped changes. Closes ckeditor/ckeditor5#7207, ckeditor/ckeditor5#7171. See Git commit message convention guide. (commit)

  • env: Added new utils that help to collect commits, parsing them, and generating the changelog. (commit)

    • The util for generating changelog from commits (those must be specified as an argument). See /lib/release-tools/utils/generatechangelog.js
    • The util for collecting commits. See /lib/release-tools/utils/getcommits.js
    • The util for suggesting new version based on commits. See /lib/release-tools/utils/getnewversiontype.js
  • env: Task generateChangelogForSinglePackage() supports new options: from - a commit or tag for collecting commits since the last release, highlightsPlaceholder - whether to add "Release highlights" placeholder in the changelog, collaborationFeatures - whether to add a URL to collaboration features changelog. (commit)

  • tests: Introduced the --port flag allowing to customize port number for automated tests server. Closes #637. (commit)

Bug fixes

  • env: The getChangedFilesForCommit() util filters files returned by the Git command. It won't return an empty string anymore. (commit)

Other changes

  • env: Adjusted release tools to handle single mono-repository architecture. Closes #606. (commit)
  • env: Commits in the changelog will display the word commit instead of the first 7 characters from the commit's hash. In big repositories (the number of commits is huge), 7 characters are not unique anymore. (commit)
  • env: Closes references will be merged into a single entry. Github does not support such references (Closes x, y) but it can be simplified during the commit's transformation. (commit)
  • env: The provideVersion() util from lib/release-tools/utils/cli.js allows disabling returning skip version by setting its option disableSkipVersion to true. (commit)
  • tests: Removed unnecessary scripts after merging the main repository to the monorepo. Closes #628. (commit)
  • Removed lerna and all its files from the project. Now the release process is handled by our tools. The entire repository will follow the same rules as ckeditor5. Read more in the Versioning policy guide. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Major releases (contain major breaking changes):

Releases containing new features:

Other releases: