Skip to content

Commit

Permalink
Merge pull request #17154 from ckeditor/master_to_release
Browse files Browse the repository at this point in the history
Internal: Merge master to release for testing phase.
  • Loading branch information
martnpaneq authored Sep 25, 2024
2 parents 6b1e550 + a08fef0 commit 52b5183
Show file tree
Hide file tree
Showing 257 changed files with 5,087 additions and 1,579 deletions.
16 changes: 8 additions & 8 deletions .circleci/template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ jobs:
at: .out
- run:
name: Merge the code coverage of the framework and features
command: cat .out/combined_framework.info .out/combined_features.info > .out/combined_lcov.info
command: cat .out/combined_framework.info .out/combined_features_batch_n.info > .out/combined_lcov.info
- run:
name: Preparing the environment variables
command: |
Expand Down Expand Up @@ -234,7 +234,7 @@ jobs:

notify_ci_failure:
machine: true
resource_class: xlarge
resource_class: medium
parameters:
hideAuthor:
type: string
Expand Down Expand Up @@ -263,7 +263,7 @@ jobs:

workflows:
version: 2
# `cke5_tests_framework` and `cke5_tests_features` jobs are generated by the `scripts/ci/generate-config-tests.js` script.
# `cke5_tests_framework` and `cke5_tests_features_batch_n` jobs are generated by the `scripts/ci/generate-config-tests.js` script.
main:
when:
and:
Expand All @@ -275,15 +275,15 @@ workflows:
branches:
ignore:
- stable
- cke5_tests_features:
- cke5_tests_features_batch_n:
filters:
branches:
ignore:
- stable
- cke5_coverage:
requires:
- cke5_tests_framework
- cke5_tests_features
- cke5_tests_features_batch_n
filters:
branches:
only:
Expand All @@ -304,7 +304,7 @@ workflows:
- cke5_trigger_uber_ci:
requires:
- cke5_tests_framework
- cke5_tests_features
- cke5_tests_features_batch_n
- cke5_coverage
- cke5_validators
- cke5_manual
Expand All @@ -316,7 +316,7 @@ workflows:
- cke5_trigger_release_process:
requires:
- cke5_tests_framework
- cke5_tests_features
- cke5_tests_features_batch_n
- cke5_validators
- cke5_manual
- release_prepare
Expand All @@ -336,7 +336,7 @@ workflows:
when: << pipeline.parameters.isNightly >>
jobs:
- cke5_tests_framework
- cke5_tests_features
- cke5_tests_features_batch_n
- cke5_validators
- cke5_manual
- release_prepare
Expand Down
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,7 @@ The full list of enhancements can be found below.

### MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)

* **Reverted `config.sanitizeHtml`.** In v43.0.0 we made a decision to move `config.htmlEmbed.sanitizeHtml` to a top-level property `config.sanitizeHtml`. However, we realized that it was a wrong decision to expose such a sensitive property in a top-level configuration property. Starting with v43.1.0 you should again use `config.htmlEmbed.sanitizeHtml` and/or `config.mergeFields.sanitizeHtml`. The editor will throw an error if `config.sanitizeHtml` is used. See the {@link
updating/update-to-43#reverted-recently-introduced-configsanitizehtml migration guide} for additional context behind this decision.
* **Reverted `config.sanitizeHtml`.** In v43.0.0 we made a decision to move `config.htmlEmbed.sanitizeHtml` to a top-level property `config.sanitizeHtml`. However, we realized that it was a wrong decision to expose such a sensitive property in a top-level configuration property. Starting with v43.1.0 you should again use `config.htmlEmbed.sanitizeHtml` and/or `config.mergeFields.sanitizeHtml`. The editor will throw an error if `config.sanitizeHtml` is used. See the [migration guide](https://ckeditor.com/docs/ckeditor5/latest/updating/guides/update-to-43.html#reverted-recently-introduced-configsanitizehtml) for additional context behind this decision.
* **[ai](https://www.npmjs.com/package/@ckeditor/ckeditor5-ai)**: The structure and presentation of the list of AI commands in the toolbar have changed (a flat filtered list is now a nested menu). Additionally, if your integration customizes this user interface, please ensure your integration code is up-to-date.
* **[ui](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui)**: The default `[aria-label]` provided by `InlineEditableUIView` is now `'Rich Text Editor. Editing area: [root name]'` (previously: `'Editor editing area: [root name]'`). You can use the `options.label` constructor property to adjust the label.

Expand Down
8 changes: 1 addition & 7 deletions docs/_snippets/features/keyboard-support.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/

/* globals window, document, open, console, LICENSE_KEY */
/* globals window, document, console, LICENSE_KEY */

// Keep the guide listing updated with each change.

Expand Down Expand Up @@ -59,15 +59,9 @@ import { Template } from '@ckeditor/ckeditor5-template';
import { TextTransformation } from '@ckeditor/ckeditor5-typing';
import WProofreader from '@webspellchecker/wproofreader-ckeditor5/src/wproofreader.js';

// Additional protection for internal license keys CF#2555.
window.open.closed = 1;

// import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
import { TOKEN_URL } from '@ckeditor/ckeditor5-ckbox/tests/_utils/ckbox-config.js';

// Allow using internal license keys in this sample. See CF#2555.
open.closed = 1;

// Templates icons.
import articleImageRightIcon from '../../assets/img/article-image-right.svg';
import financialReportIcon from '../../assets/img/financial-report.svg';
Expand Down
72 changes: 72 additions & 0 deletions docs/_snippets/getting-started/use-builder.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<div class="builder-cta">
<h2 id="ckeditor-5-builder">CKEditor&nbsp;5 Builder</h2>

<p>
In our interactive Builder you can quickly get a taste of CKEditor&nbsp;5. It offers an easy-to-use user interface to help you configure, preview, and download the editor suited to your needs. You can easily select:
</p>

<ul>
<li>The editor type.</li>
<li>The features you need.</li>
<li>Preferred framework (React, Angular, Vue or Vanilla JS).</li>
<li>Preferred distribution method.</li>
</ul>

<p>At the end you get ready-to-use code tailored to your needs!</p>

<p>
<a href="https://ckeditor.com/ckeditor-5/builder?redirect=docs" target="_blank">Check out our interactive Builder</a>
</p>
</div>

<style>
.builder-cta {
border: 1px solid #ECE6F7;
border-left: 4px solid #A183D9;
padding: 24px;
margin: 32px 0 20px;
}

.builder-cta h2 {
padding-top: 0;
border: 0;
}

.builder-cta ul {
margin: 18px 24px;
}

.builder-cta ul li {
list-style-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 15 16" width="18" height="18" fill="none"><path fill="%236A38C1" fill-rule="evenodd" d="M11.041 14.432a.74.74 0 0 0 .24-.182l3.368-3.569a.763.763 0 0 0 .236-.246.816.816 0 0 0 .074-.678.794.794 0 0 0-.175-.297L11.28 5.75a.742.742 0 0 0-.24-.182.705.705 0 0 0-.824.162.824.824 0 0 0 .019 1.128l2.257 2.392H3.75a.75.75 0 0 0 0 1.5h8.742l-2.257 2.392a.823.823 0 0 0-.019 1.128c.071.075.155.133.247.173a.703.703 0 0 0 .578-.01Z" clip-rule="evenodd"/></svg>');
padding-inline-start: 4px;
}

.builder-cta ul li+li {
margin-top: 4px;
}

.builder-cta a {
display: inline-block;
background-color: #6A38C1;
color: #FFFFFF;
font-weight: bold;
text-decoration: none;
margin-top: 8px;
padding: 8px 16px;
border-radius: 6px;
}

.builder-cta a:hover,
.builder-cta a:focus {
background-color: #5C32A4;
}

.builder-cta a::after {
content: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 14 15" width="18" height="18" fill="none"><path fill="white" d="M8.765 14.566a.75.75 0 1 1-1.06-1.06l3.005-3.007-3.005-3.005a.75.75 0 1 1 1.06-1.06l3.55 3.55a.75.75 0 0 1-.136 1.168l-3.414 3.414Z"/></svg>');
padding-inline-start: 4px;
}

.builder-cta p:last-child {
margin-bottom: 0;
}
</style>
4 changes: 4 additions & 0 deletions docs/_snippets/getting-started/use-builder.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
2 changes: 1 addition & 1 deletion docs/examples/builds/balloon-block-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The balloon block editor type lets you create your content directly in its targe
* A {@link getting-started/setup/toolbar#block-toolbar block toolbar} accessible using the toolbar handle button {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} attached to the editable content area and following the selection in the document (bringing additional block formatting tools). The {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} button is also a handle that can be used to drag and drop blocks around the content.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon-block) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon-block) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/balloon-block-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/balloon-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ classes: main__content--no-toc
The balloon editor type lets you create your content directly in its target location with the help of a balloon toolbar that appears next to the selected editable document element.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/balloon-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/classic-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ classes: main__content--no-toc
The classic editor type shows a boxed editing area with a toolbar, placed in a specific position on the page.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-classic) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-classic) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/classic-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/document-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The editor in this example is a feature–rich preset focused on rich text editi
See the {@link framework/document-editor tutorial} to learn how to create this kind of an editor (and similar) with a custom UI layout on top of {@link module:editor-decoupled/decouplededitor~DecoupledEditor}.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-document) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-document) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/document-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/inline-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The inline editor type lets you create your content directly in its target locat
In this example the {@link features/images-styles image styles} configuration was changed to enable left- and right-aligned images.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-inline) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-inline) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/inline-editor}
4 changes: 2 additions & 2 deletions docs/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Keep full control of your work. Be safe and never lose anything thanks to the {@

### Customizable user experience

Work as you like it &ndash; choose a user interface approach from several predefined layouts, add features to your preset or remove them with the [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs), or use the {@link getting-started/advanced/dll-builds DLL builds}. Then tailor the user interface to your needs with a customizable {@link getting-started/setup/toolbar editor toolbar}, arranging feature buttons, dropdowns, and other items in whatever way you need.
Work as you like it &ndash; choose a user interface approach from several predefined layouts, add features to your preset or remove them with the [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs), or use the {@link getting-started/advanced/dll-builds DLL builds}. Then tailor the user interface to your needs with a customizable {@link getting-started/setup/toolbar editor toolbar}, arranging feature buttons, dropdowns, and other items in whatever way you need.

{@img assets/img/full-toolbar.png 938 CKEditor&nbsp;5 customizable UI.}

Expand All @@ -126,7 +126,7 @@ If you want to migrate from CKEditor 4 to CKEditor&nbsp;5, check the {@link upda
We present each rich-text editor feature on a separate page. It includes one or more working demos showcasing a feature along with some customization ideas that you can use in your implementation.

<info-box>
**In most feature demos the number of features enabled is limited** to make the exposed piece of functionality stand out more, as shown in the screenshots above. But in your CKEditor&nbsp;5 WYSIWYG editor implementation you are free to choose and combine any features you like from those available. You can achieve this by using the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
**In most feature demos the number of features enabled is limited** to make the exposed piece of functionality stand out more, as shown in the screenshots above. But in your CKEditor&nbsp;5 WYSIWYG editor implementation you are free to choose and combine any features you like from those available. You can achieve this by using the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

## Why does the editor filter out content (styles, classes, elements)
Expand Down
6 changes: 6 additions & 0 deletions docs/framework/contributing/git-commit-message-convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ The proper order of sections for a commit message is as follows:

All entries must be separated with a blank line, otherwise the lines will not be treated as separate entries.

### Squash commits

The changelog generator understands squash commits created by GitHub when merging a pull request.

When using the _"Squash and merge"_ option, ensure the default commit title is not modified. It should contain the pull request title and its number, for example: `Sample pull request (#000)`. The changelog entries should be added as a commit description. They must follow the same rules as merge commits.

### Examples of correct and incorrect message formatting

An example of a proper commit message:
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/contributing/package-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ modified_at: 2021-06-07

The package metadata is a set of CKEditor&nbsp;5-related data describing plugins that the package delivers. It allows for the automated detection of plugins and building them by an external builder.

In the case of official CKEditor&nbsp;5 packages (as well as some partner ones), this data is used by the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) and allows for building the {@link framework/architecture/plugins#plugins-and-html-output Features' HTML output} page presenting a list of all official CKEditor&nbsp;5 plugins.
In the case of official CKEditor&nbsp;5 packages (as well as some partner ones), this data is used by the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) and allows for building the {@link framework/architecture/plugins#plugins-and-html-output Features' HTML output} page presenting a list of all official CKEditor&nbsp;5 plugins.

The package metadata should be saved in the special `ckeditor5-metadata.json` file in the root of the package published on npm.

Expand Down
1 change: 0 additions & 1 deletion docs/framework/contributing/testing-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ It accepts the following arguments that must be passed after the `--` option:
* `--verbose` (alias `-v`) &ndash; Allows switching on webpack logs.
* `--files` &ndash; Specifies test files to run. See the [Rules for using the `--files` option](#rules-for-using-the-files-option) section.
* `--browsers` &ndash; Browsers that will be used to run the tests. Defaults to `Chrome`.
* `--debug` (alias `-d`) &ndash; Allows specifying custom debug flags. For example, the `--debug engine` option uncomments the `// @if CK_DEBUG_ENGINE //` lines in the code. By default `--debug` is set to `true` even if you did not specify it. This enables the base set of debug logs (`// @if CK_DEBUG //`) which should always be enabled in the testing environment. You can completely turn off the debug mode by setting the `--debug false` option.
* `--port` &ndash; Specifies the port for the server to use. Defaults to `9876`.
* `--identity-file="/path/to/file.js"` (alias `-i`) &ndash; Path to the file containing the license key(s) for closed–source features.

Expand Down
Loading

0 comments on commit 52b5183

Please sign in to comment.