From b72b20b23640d7357a85faa6d0e05f3ff4c7cb5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Smyrek?= Date: Wed, 7 Aug 2024 11:57:10 +0200 Subject: [PATCH 1/3] Added missing `from` option for changelog script. --- scripts/changelog.js | 1 + scripts/utils/parsearguments.js | 1 + 2 files changed, 2 insertions(+) diff --git a/scripts/changelog.js b/scripts/changelog.js index c473e82..cd9771b 100755 --- a/scripts/changelog.js +++ b/scripts/changelog.js @@ -18,5 +18,6 @@ const cliArguments = parseArguments( process.argv.slice( 2 ) ); import { generateChangelogForSinglePackage } from '@ckeditor/ckeditor5-dev-release-tools'; await generateChangelogForSinglePackage( { + from: cliArguments.from, releaseBranch: cliArguments.branch } ); diff --git a/scripts/utils/parsearguments.js b/scripts/utils/parsearguments.js index 60b4cbf..57eae6f 100644 --- a/scripts/utils/parsearguments.js +++ b/scripts/utils/parsearguments.js @@ -21,6 +21,7 @@ export default function parseArguments( cliArguments ) { string: [ 'branch', + 'from', 'npm-tag' ], From 5fc488a7156429a57f31cafbdc7ca6718ed9704b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Smyrek?= Date: Wed, 7 Aug 2024 11:58:15 +0200 Subject: [PATCH 2/3] Docs: Changelog. [skip ci] --- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9d873e..be42e2c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,35 @@ Changelog ========= +## [7.0.0](https://github.com/ckeditor/ckeditor5-vue/compare/v6.0.0...v7.0.0) (2024-08-07) + +### BREAKING CHANGES + +* Bump required version to Vue 3.4+. See [#282](https://github.com/ckeditor/ckeditor5-vue/issues/282). +* Change the global name used in the UMD build from `CKEditor` to `CKEDITOR_VUE`. +* Export the component as `Ckeditor` instead of `default.component`. Closes [#284](https://github.com/ckeditor/ckeditor5-vue/issues/284). +* Migrate to Composition API. Closes [#172](https://github.com/ckeditor/ckeditor5-vue/issues/172). +* Migrate to ESM. See [ckeditor/ckeditor5#16616](https://github.com/ckeditor/ckeditor5/issues/16616). +* Remove argument from the `destroy` event, as it was always `null`. Closes [#283](https://github.com/ckeditor/ckeditor5-vue/issues/283). +* Rename main package exports to `CkeditorPlugin` and `Ckeditor`. +* Replace the default export with named `CKEditorPlugin` export. + +### Features + +* Add UMD for better backward compatibility. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/0412b19f26ef954a7cf8fb8c2bc7d1bce686e0e6)) + +### Bug fixes + +* Change the global name used in the UMD build from `CKEditor` to `CKEDITOR_VUE` to match the new convention. See [ckeditor/ckeditor5#16736](https://github.com/ckeditor/ckeditor5/issues/16736). ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/eba73a525e1422ff3a3a1a95825d6c4807b3a232)) +* Fix the component properties and event types. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/e2a9bbcaec754ab680fc28dae545ea27defe68e3)) +* Use type of the passed `editor` prop rather than generic `Editor` type. Closes [#282](https://github.com/ckeditor/ckeditor5-vue/issues/282). ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/c82a0040dfd2f23a87aca257c354b6a2c302c340)) + +### Other changes + +* Rename exports to improve name of the editor component in Vue. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/fac44822ca6f41c9a7ea4b529b6274da1ee66cfc)) +* Updated yarn.lock to fix dependabot alert. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/e0d7a9e9c974025f6d0060b70d1d19718cb14f48)) + + ## [7.0.0-alpha.2](https://github.com/ckeditor/ckeditor5-vue/compare/v7.0.0-alpha.1...v7.0.0-alpha.2) (2024-07-17) ### BREAKING CHANGES From 063bd8359fbd6e13d903fbf20cabefa20695cef9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Smyrek?= Date: Wed, 7 Aug 2024 12:04:34 +0200 Subject: [PATCH 3/3] Changelog for v7.0.0. --- CHANGELOG.md | 43 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index be42e2c..17b258c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,42 @@ Changelog ## [7.0.0](https://github.com/ckeditor/ckeditor5-vue/compare/v6.0.0...v7.0.0) (2024-08-07) +We are excited to announce a new major release of the Vue integration. + +In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier. + +* **Composition API**: The integration has been rewritten in Composition API, which follows the recommended way of writing components in Vue 3. +* **Vue 3.4+**: The minimum required version of Vue is now 3.4+ because we are using the [Generics](https://vuejs.org/api/sfc-script-setup.html#generics) and [`defineModel()`](https://vuejs.org/api/sfc-script-setup.html#definemodel) features to provide better typings for the `editor` prop and component events. +* **ESM-first**: Besides the UMD build, the integration is now available in ESM format. In most projects, the new ESM build should be automatically prioritized by bundlers and other tools. +* **Changed exports**: We have changed how the Vue plugin and component are exported. The Vue plugin is no longer the `default` export but is exported as `CkeditorPlugin`. The component is now exported as `Ckeditor` instead of `default.component`. + + Here's a comparison of how you can import the Vue plugin that registers a global `` component: + + ```ts + // Before the release. + import CKEditor from '@ckeditor/ckeditor5-vue'; + + // After the release. + import { CkeditorPlugin } from '@ckeditor/ckeditor5-vue'; + ``` + + If you prefer to use a local component instead of a global component, here's a comparison of how you can import it: + + ```ts + // Before the release. + import CKEditor from '@ckeditor/ckeditor5-vue'; + + const component = CKEditor.component; + + // After the release. + import { Ckeditor } from '@ckeditor/ckeditor5-vue'; + + const component = Ckeditor; + ``` + +* **Remove the `editor` argument from the `destroy` event**: The `destroy` event no longer has an `editor` argument since it was always `null`. +* **New name of the global variable**: The name of the global variable used in the UMD build changed from `CKEditor` to `CKEDITOR_VUE`. + ### BREAKING CHANGES * Bump required version to Vue 3.4+. See [#282](https://github.com/ckeditor/ckeditor5-vue/issues/282). @@ -12,11 +48,6 @@ Changelog * Migrate to ESM. See [ckeditor/ckeditor5#16616](https://github.com/ckeditor/ckeditor5/issues/16616). * Remove argument from the `destroy` event, as it was always `null`. Closes [#283](https://github.com/ckeditor/ckeditor5-vue/issues/283). * Rename main package exports to `CkeditorPlugin` and `Ckeditor`. -* Replace the default export with named `CKEditorPlugin` export. - -### Features - -* Add UMD for better backward compatibility. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/0412b19f26ef954a7cf8fb8c2bc7d1bce686e0e6)) ### Bug fixes @@ -27,8 +58,6 @@ Changelog ### Other changes * Rename exports to improve name of the editor component in Vue. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/fac44822ca6f41c9a7ea4b529b6274da1ee66cfc)) -* Updated yarn.lock to fix dependabot alert. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/e0d7a9e9c974025f6d0060b70d1d19718cb14f48)) - ## [7.0.0-alpha.2](https://github.com/ckeditor/ckeditor5-vue/compare/v7.0.0-alpha.1...v7.0.0-alpha.2) (2024-07-17)