Skip to content

Commit

Permalink
Merge branch 'master' into i/3772-esm
Browse files Browse the repository at this point in the history
  • Loading branch information
pomek committed Sep 20, 2024
2 parents 32ed547 + 01d1396 commit 340adaa
Show file tree
Hide file tree
Showing 30 changed files with 1,357 additions and 67 deletions.
14 changes: 7 additions & 7 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 @@ -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.mjs` script.
# `cke5_tests_framework` and `cke5_tests_features_batch_n` jobs are generated by the `scripts/ci/generate-config-tests.mjs` 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
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
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
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
11 changes: 8 additions & 3 deletions docs/getting-started/integrations/angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,18 @@ Because of the breaking changes in the Angular library output format, the `@cked
<td colspan="3">Actively supported versions</td>
</tr>
<tr>
<td><code>^8</code></td>
<td><code>13+</code></td>
<td>Requires CKEditor&nbsp;5 in version <a href="https://github.com/ckeditor/ckeditor5/releases/tag/v42.0.0">42</a> or higher.</td>
<td><code>^9</code></td>
<td><code>16+</code></td>
<td>Migration to TypeScript&nbsp;5. Declaration files are not backward compatible. Requires CKEditor&nbsp;5 in version <a href="https://github.com/ckeditor/ckeditor5/releases/tag/v43.0.0">43</a> or higher.</td>
</tr>
<tr>
<td colspan="3">Past releases (no longer maintained)</td>
</tr>
<tr>
<td><code>^8</code></td>
<td><code>13+</code></td>
<td>Requires CKEditor&nbsp;5 in version <a href="https://github.com/ckeditor/ckeditor5/releases/tag/v42.0.0">42</a> or higher.</td>
</tr>
<tr>
<td><code>^7</code></td>
<td><code>13+</code></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,34 @@ ClassicEditor
</script>
```

In some environments, you may not be able to use the import maps or JavaScript modules. In such cases, you can use the UMD builds instead. These register global variables that you can use in your scripts. This is the same setup as above, but using the UMD builds:

```html
<!-- Style sheets -->
<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.css" />
<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.css" />

<!-- Scripts -->
<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.umd.js"></script>
<script src="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.umd.js"></script>

<!-- Translations -->
<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/translations/pl.umd.js"></script>
<script src="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/translations/pl.umd.js"></script>

<script>
const { ClassicEditor, Essentials, Bold, Italic, Paragraph, Mention } = CKEDITOR;
const { FormatPainter, SlashCommand } = CKEDITOR_PREMIUM_FEATURES;
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Essentials, Bold, Italic, Paragraph, Mention, FormatPainter, SlashCommand ],
toolbar: [ /* ... */ ],
licenseKey: '<LICENSE_KEY>'
} );
</script>
```

### What's new?

There are a few things that stand out in both examples compared to the old installation methods:
Expand Down
2 changes: 1 addition & 1 deletion docs/updating/nim-migration/online-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The CDN build is a good option to quickly add CKEditor&nbsp;5 to your website wi

## ZIP archive

If you do not want to have a build process or use our CDN build, you can download the ZIP archive from the [CKEditor&nbsp;5 download page](https://ckeditor.com/ckeditor-5/download/#zip). This archive contains the editor build with all its plugins, which you can extract and include on your website.
If you do not want to have a build process or use our CDN build, you can download a ZIP archive with the editor build. We recommend using our new interactive [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) to customize the build to your needs. Then, in the `Installation` section of the Builder, you can select the `Self-hosted (ZIP)` option to learn how to add the editor to your website.

## npm package

Expand Down
Loading

0 comments on commit 340adaa

Please sign in to comment.