Skip to content

Latest commit

 

History

History
1007 lines (616 loc) · 67.3 KB

CHANGELOG.md

File metadata and controls

1007 lines (616 loc) · 67.3 KB

Changelog

25.2.6 (2021-07-13)

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

25.2.5 (2021-07-12)

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

25.2.4 (2021-06-28)

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

25.2.3 (2021-06-21)

Bug fixes

Other changes

  • tests: The Slack notifier script will read the commit message from GitHub API for a particular commit. If the SLACK_NOTIFY_COMMIT_URL variable is specified, the value will be treated as the commit. Otherwise, a concatenation of TRAVIS_REPO_SLUG, and TRAVIS_COMMIT variables will be used. (commit)
  • tests: The Slack notifier will print a message if a commit was made by a bot (as a result of merging branches). (commit)
  • tests: The Slack notifier script will work if a commit comes from the #stable branch. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

25.2.2 (2021-06-10)

Other changes

  • tests: Added the always visible button that navigates back to the list of manual tests. Refined the look of the list of manual tests. Closes ckeditor/ckeditor5#9843. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

25.2.1 (2021-05-21)

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

25.2.0 (2021-05-20)

Features

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

25.1.0 (2021-05-19)

Features

  • docs: Introduced a web crawler that allows verifying whether subpages under the specified URL can be opened without any errors. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

25.0.0 (2021-05-18)

MAJOR BREAKING CHANGES ℹ️

  • utils: The webpack configuration returned by the builds.getDllPluginWebpackConfig() function will not export the default library (libraryExport) anymore. See ckeditor/ckeditor5#9134.

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

24.4.2 (2021-03-16)

Other changes

  • tests: Ability to disable mentioning an author of the commit in the Slack notification by specifying the environment variable (SLACK_NOTIFY_HIDE_AUTHOR="true"). Closes ckeditor/ckeditor5#9252. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

24.4.1 (2021-03-12)

Bug fixes

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

24.4.0 (2021-03-08)

Features

  • tests: The notify-travis-status script will mention an author of a commit that caused to fail the CI. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

24.3.0 (2021-03-01)

Features

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

24.2.0 (2021-02-16)

Features

  • env: The bumpVersions() function can read the changelog file from an external directory (using options.changelogDirectory). Thanks to that, the private packages from the mono-repository can be released using a public changelog. (commit)
  • env: The bumpVersions() function allows skipping upgrading versions of dependencies between updated packages (using options.skipUpdatingDependencies which is false by default). (commit)

Bug fixes

  • env: Simplified a check whether a package was published on NPM in the releaseSubRepositories() function. (commit)
  • utils: A DLL-consumer package produced by webpack should be assigned to the window object. See ckeditor/ckeditor5#9039. (commit)

Other changes

  • env: The bumpVersions() function returns a promise with a collection that contains all updated packages. Previously the promise didn't resolve anything. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

24.1.0 (2021-02-01)

Features

  • env: Support for collecting commits from additional mono-repositories in the generateChangelogForMonoRepository() function. (commit)
  • utils: Added a module (builds.getDllPluginWebpackConfig()) that produces the webpack configuration for DLL. See ckeditor/ckeditor5#8395. (commit)

Bug fixes

  • env: The "releaserepositories.js" script should not throw an error if the "options.customReleasesFiles" option is not specified. Closes ckeditor/ckeditor5#8932. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

24.0.2 (2021-01-20)

Other changes

  • tests: Minor improvements for the dependency checker that is exposed as a binary script by the @ckeditor/ckeditor5-dev-tests package (ckeditor5-dev-tests-check-dependencies). Closes ckeditor/ckeditor5#8862. (commit)

    • Added a flag --quiet that allows display logs only if found issues with dependencies,
    • If packages were not specified in arguments, all packages found in the packages/ directory will be checked by default.

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

24.0.1 (2021-01-19)

Bug fixes

  • env: Changed packages in the generated changelog will be grouped properly by exact comparing their scopes instead of matching values. Closes ckeditor/ckeditor5#8596. (commit)
  • tests: Improved the dependency checker in detecting missing, unused, or misplaced packages from JS, CSS, and package.json files. Closes ckeditor/ckeditor5#8817. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

24.0.0 (2021-01-11)

MAJOR BREAKING CHANGES ℹ️

  • env: Renamed options.packageJsonForEmptyReleases to options.packageJsonForCustomReleases in the releaseSubRepositories() function.
  • env: Renamed options.emptyReleases to options.customReleases in the releaseSubRepositories() function.

Features

  • env: The idea of having "emptyReleases" has been changed to "customReleases" that allows specifying which files from the original package should be copied. Introduced the customReleasesFiles option for the releaseSubRepositories() function. It allows specifying glob patterns of files that should be copied to the temporary directory from which the package will be published on npm. Closes [ckeditor/ckeditor5#8616](ckeditor/ckeditor5#8616). (commit)
  • env: Added the "--include-external-directory" to the translations:collect task that allows checking packages located in the "external/" directory. See ckeditor/ckeditor5#7901. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Major releases (contain major breaking changes):

Other releases:

23.6.1 (2020-11-06)

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

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

23.6.0 (2020-10-22)

Features

  • env: generateChangelogForMonoRepository() accepts a new option options.skipLinks (which is false by default) to omit release and commit links in the generated changelog. Closes ckeditor/ckeditor5#8167. (commit)
  • env: generateChangelogForSinglePackage() accept an optional option: options.releaseBranch (which defaults to master). (commit)

Bug fixes

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

23.5.1 (2020-09-04)

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

23.5.0 (2020-09-04)

Features

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

23.4.0 (2020-09-02)

Features

  • tests: Introduced the --repositories (also known as -r) option that allows specifying a name of a repository (or repositories, separated by a comma, similar to the --files option) where the tool should look for packages that should be tested. Thanks to that, you do not have to specify all packages of a repository that was cloned into the external/ directory. Closes ckeditor/ckeditor5#7889. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

23.3.0 (2020-09-01)

Features

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

23.2.0 (2020-08-20)

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:

23.1.1 (2020-08-05)

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

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

23.1.0 (2020-08-03)

Features

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

23.0.0 (2020-07-21)

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:

22.0.0 (2020-07-20)

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:

21.0.0 (2020-06-22)

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):

20.2.1 (2020-06-01)

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

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

20.2.0 (2020-05-31)

Features

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

20.1.0 (2020-05-27)

Features

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Releases containing new features:

Other releases:

20.0.0 (2020-05-22)

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: