Releases: ckeditor/ckeditor5-dev
v23.2.0
Features
- jsdoc-plugins: Introduced a plugin that hides the package documentation if in the package's
package.json
file theprivate
key is set totrue
. 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 displayingconsole.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:
- @ckeditor/ckeditor5-dev-docs: v23.1.1 => v23.2.0
- @ckeditor/ckeditor5-dev-tests: v23.1.1 => v23.2.0
- @ckeditor/jsdoc-plugins: v23.1.1 => v23.2.0
Other releases:
- @ckeditor/ckeditor5-dev-env: v23.1.1 => v23.2.0
- @ckeditor/ckeditor5-dev-utils: v23.1.1 => v23.2.0
- @ckeditor/ckeditor5-dev-webpack-plugin: v23.1.1 => v23.2.0
v23.1.1
Internal changes only (updated dependencies, documentation, etc.).
Released packages
Check out the Versioning policy guide for more information.
Released packages (summary)
Other releases:
- @ckeditor/ckeditor5-dev-docs: v23.1.0 => v23.1.1
- @ckeditor/ckeditor5-dev-env: v23.1.0 => v23.1.1
- @ckeditor/ckeditor5-dev-tests: v23.1.0 => v23.1.1
- @ckeditor/ckeditor5-dev-utils: v23.1.0 => v23.1.1
- @ckeditor/ckeditor5-dev-webpack-plugin: v23.1.0 => v23.1.1
- @ckeditor/jsdoc-plugins: v23.1.0 => v23.1.1
v23.1.0
Features
- tests: Dependency checker will look for duplicated dependencies. Closes ckeditor/ckeditor5#7706. (commit)
- webpack-plugin: Add support for the
translationsOutputFile
option forCKEditorWebpackPlugin
allowing specifying the target bundle for translations. Closes ckeditor/ckeditor5#7688. (commit)
Bug fixes
- jsdoc-plugins: Whitespaces from code blocks should be removed properly. Closes ckeditor/ckeditor5#7742. (commit)
Released packages
Check out the Versioning policy guide for more information.
Released packages (summary)
Releases containing new features:
- @ckeditor/ckeditor5-dev-env: v23.0.0 => v23.1.0
- @ckeditor/ckeditor5-dev-tests: v23.0.0 => v23.1.0
- @ckeditor/ckeditor5-dev-utils: v23.0.0 => v23.1.0
- @ckeditor/ckeditor5-dev-webpack-plugin: v23.0.0 => v23.1.0
- @ckeditor/jsdoc-plugins: v23.0.0 => v23.1.0
Other releases:
- @ckeditor/ckeditor5-dev-docs: v23.0.0 => v23.1.0
v23.0.0
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):
- @ckeditor/jsdoc-plugins: v22.0.0 => v23.0.0
Other releases:
- @ckeditor/ckeditor5-dev-docs: v22.0.0 => v23.0.0
- @ckeditor/ckeditor5-dev-env: v22.0.0 => v23.0.0
- @ckeditor/ckeditor5-dev-tests: v22.0.0 => v23.0.0
- @ckeditor/ckeditor5-dev-utils: v22.0.0 => v23.0.0
- @ckeditor/ckeditor5-dev-webpack-plugin: v22.0.0 => v23.0.0
v22.0.0
MAJOR BREAKING CHANGES ℹ️
- env: Task
generateChangelogForMonoRepository()
will generate the changelog uses the same version for all packages.
Features
- tests: Added
sinon-chai
to automated tests. Closes ckeditor/ckeditor5#7456. (commit)
Bug fixes
- env: The
getCommit()
util will return a proper array with commits if the release branch in the project is other thanmaster
. Due to--first-parent
flag which is used for collecting the commits, when the release branch is other thanmaster
, commits made onmaster
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 supportsoptions.releaseBranch
that is passed directly to thegetCommit()
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):
- @ckeditor/ckeditor5-dev-env: v21.0.0 => v22.0.0
Releases containing new features:
- @ckeditor/ckeditor5-dev-tests: v21.0.0 => v22.0.0
Other releases:
- @ckeditor/ckeditor5-dev-docs: v21.0.0 => v22.0.0
- @ckeditor/ckeditor5-dev-utils: v21.0.0 => v22.0.0
- @ckeditor/ckeditor5-dev-webpack-plugin: v21.0.0 => v22.0.0
- @ckeditor/jsdoc-plugins: v21.0.0 => v22.0.0
v21.0.0
MAJOR BREAKING CHANGES ℹ️
- Minimal version of Node.js for all packages included in the repository has been increased to 12.0.0.
Features
- env: Translation tools can handle external packages outside the CKEditor 5 repository. Closes ckeditor/ckeditor5#6635. (commit)
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
- Upgraded versions of all dependencies. See ckeditor/ckeditor5#7202. (commit)
Released packages
Check out the Versioning policy guide for more information.
Released packages (summary)
Major releases (contain major breaking changes):
- @ckeditor/ckeditor5-dev-docs: v20.0.0 => v21.0.0
- @ckeditor/ckeditor5-dev-env: v20.2.0 => v21.0.0
- @ckeditor/ckeditor5-dev-tests: v20.0.2 => v21.0.0
- @ckeditor/ckeditor5-dev-utils: v20.0.0 => v21.0.0
- @ckeditor/ckeditor5-dev-webpack-plugin: v20.0.0 => v21.0.0
- @ckeditor/jsdoc-plugins: v20.0.0 => v21.0.0
- eslint-config-ckeditor5: v2.1.0 => v3.0.0
- eslint-plugin-ckeditor5-rules: v0.0.5 => v1.0.0
- stylelint-config-ckeditor5: v1.0.3 => v2.0.0
v20.2.1
Internal changes only (updated dependencies, documentation, etc.).
Released packages
Check out the Versioning policy guide for more information.
v20.2.0
Features
- env: Release commit will trigger a Continuous Integration service. Closes ckeditor/ckeditor5#7302. (commit)
Bug fixes
- env: The changelog generator will properly merge the
Closes
references. Closes ckeditor/ckeditor5#7298. (commit) - env: References to issues in additional commits will be merged and linked. See ckeditor/ckeditor5#7298. (commit)
- env: The
releaseSubRepositories()
task should not throw any error if publishing from the non-master branch. Closes ckeditor/ckeditor5#7300. (commit)
Released packages
Check out the Versioning policy guide for more information.
Released packages (summary)
Releases containing new features:
- @ckeditor/ckeditor5-dev-env: v20.1.0 => v20.2.0
v20.1.0
Features
- env: Allows releasing packages from the non-master branch. Closes ckeditor/ckeditor5#7271. (commit)
Bug fixes
- tests: The getRelativeFilePath() util will return proper paths for CKEditor 5 builds. Closes ckeditor/ckeditor5#7280. Closes ckeditor/ckeditor5#7093. (commit)
Released packages
Check out the Versioning policy guide for more information.
Released packages (summary)
Releases containing new features:
- @ckeditor/ckeditor5-dev-env: v20.0.0 => v20.1.0
Other releases:
- @ckeditor/ckeditor5-dev-tests: v20.0.0 => v20.0.1
v20.0.0
MAJOR BREAKING CHANGES ℹ️
- env: Removed
generateChangelogForSubPackages()
task. UsegenerateChangelogForMonoRepository()
instead. - env: Removed
generateChangelogForSubRepositories()
task. UsegenerateChangelogForMonoRepository()
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()
andhasMinorBreakingChanges()
utils from/lib/release-tools/utils/changelog.js
helper. - env: Removed the
getNewReleaseType()
util. UsegetCommits()
andgetNewVersionType()
instead. - env: Removed
getSubPackagesPaths()
util. - env: Renamed
getSubRepositoriesPaths()
util togetPackagesPaths()
. - env: The util
getPackagesPaths()
does not check whether packages are defined asdependencies
inpackage.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
- The util for generating changelog from commits (those must be specified as an argument). See
-
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 fromlib/release-tools/utils/cli.js
allows disabling returningskip
version by setting its optiondisableSkipVersion
totrue
. (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 asckeditor5.
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):
- @ckeditor/ckeditor5-dev-env: v18.0.1 => v20.0.0
Releases containing new features:
- @ckeditor/ckeditor5-dev-docs: v11.1.1 => v20.0.0
Other releases:
- @ckeditor/ckeditor5-dev-tests: v19.2.0 => v20.0.0
- @ckeditor/ckeditor5-dev-utils: v13.0.1 => v20.0.0
- @ckeditor/ckeditor5-dev-webpack-plugin: v9.0.2 => v20.0.0
- @ckeditor/jsdoc-plugins: v3.0.9 => v20.0.0