You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Optional: Affected package(s), using short names.
16
+
# Example: ckeditor5-core
17
+
scope:
18
+
- ckeditor5-dev-release-tools
19
+
20
+
# Optional: Issues this change closes.
21
+
# Format:
22
+
# - {issue-number}
23
+
# - {repo-owner}/{repo-name}#{issue-number}
24
+
# - Full GitHub URL
25
+
closes:
26
+
-
27
+
28
+
# Optional: Related issues.
29
+
# Format:
30
+
# - {issue-number}
31
+
# - {repo-owner}/{repo-name}#{issue-number}
32
+
# - Full GitHub URL
33
+
see:
34
+
-
35
+
36
+
# Optional: Community contributors.
37
+
# Format:
38
+
# - @{github-username}
39
+
communityCredits:
40
+
-
41
+
---
42
+
43
+
The `checkVersionAvailability()` and `findPathsToPackages()` functions exported by the `@ckeditor/ckeditor5-dev-release-tools` package have been moved to the `@ckeditor/ckeditor5-dev-utils` package.
44
+
45
+
For backward compatibility, they are still available in the `@ckeditor/ckeditor5-dev-release-tools` package and will be removed in the next major release.
This repository uses Markdown files to define changelog entries. If the changes in this pull request are **user-facing**, please create a changelog entry by running the following command:
4
+
5
+
yarn nice
6
+
7
+
This will generate a `*.md` file in the `.changelog/` directory for your description. You can create as many as you need.
8
+
9
+
**Note:**
10
+
If your PR is internal-only (e.g., tests, tooling, docs), you can skip this step - just mention it below.
11
+
12
+
-->
13
+
14
+
### 🚀 Summary
15
+
16
+
*A brief summary of what this PR changes.*
17
+
18
+
---
19
+
20
+
### 📌 Related issues
21
+
22
+
<!--
23
+
24
+
Although changelog entries list connected issues, GitHub requires listing them here to automatically link and close them.
25
+
26
+
-->
27
+
28
+
* Closes #000
4
29
5
30
---
6
31
7
-
### Additional information
32
+
### 💡 Additional information
8
33
9
-
*For example – encountered issues, assumptions you had to make, other affected tickets, etc.*
34
+
*Optional: Notes on decisions, edge cases, or anything helpful for reviewers.*
Copy file name to clipboardExpand all lines: DEPRECATIONS.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,3 +9,23 @@ Below, you can find all deprecation codes used in the `ckeditor5-dev-*` packages
9
9
### DEP0001: `verifyPackagesPublishedCorrectly()`
10
10
11
11
Since v45, the `verifyPackagesPublishedCorrectly()` function is no longer available as its responsibility has been merged with `publishPackages()`.
12
+
13
+
### DEP0002: `checkVersionAvailability()`
14
+
15
+
Since v51, the `checkVersionAvailability()` function is no longer exported by the `@ckeditor/ckeditor5-dev-release-tools` package. Use the `@ckeditor/ckeditor5-dev-utils` package instead.
Since v51, the `findPathsToPackages()` function is no longer exported by the `@ckeditor/ckeditor5-dev-release-tools` package. Use the `@ckeditor/ckeditor5-dev-utils` package instead.
Each package defines its own tests. To run them, change your working directory and use the `test` script.
49
40
50
41
Code coverage:
51
42
@@ -61,14 +52,7 @@ Before you start, you need to prepare the changelog entries.
61
52
62
53
1. Make sure the `#master` branch is up-to-date: `git fetch && git checkout master && git pull`.
63
54
1. Prepare a release branch: `git checkout -b release-[YYYYMMDD]` where `YYYYMMDD` is the current day.
64
-
1. Generate the changelog entries: `yarn run changelog --branch release-[YYYYMMDD] [--from [GIT_TAG]]`.
65
-
* By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.
66
-
67
-
The `--from` modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., `@alpha`.
68
-
69
-
**Example**: Let's assume that the `v40.5.0-alpha.0` tag is our latest and that we want to release it on a stable channel. The `--from` modifier should be equal to `--from v40.4.0`.
70
-
* This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. If changes were irrelevant (e.g., only dependencies), it would make an "_internal changes_" entry.
71
-
* Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
55
+
1. Generate the changelog entries: `yarn run release:prepare-changelog`.
72
56
1. Commit all changes and prepare a new pull request targeting the `#master` branch.
73
57
1. Ping the `@ckeditor/ckeditor-5-platform` team to review the pull request and trigger the release process.
0 commit comments