@ckeditor/ckeditor5-dev-changelog 55.6.3 → 56.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -1
- package/dist/tasks/generatechangelogformonorepository.d.ts +4 -0
- package/dist/tasks/generatechangelogforsinglerepository.d.ts +4 -0
- package/dist/template.d.ts +4 -0
- package/dist/template.js +0 -3
- package/dist/utils/commitchanges.d.ts +4 -0
- package/dist/utils/composechangelog.d.ts +4 -0
- package/dist/utils/constants.d.ts +4 -0
- package/dist/utils/detectreleasechannel.d.ts +4 -0
- package/dist/utils/determinenextversion.d.ts +4 -0
- package/dist/utils/displaychanges.d.ts +4 -0
- package/dist/utils/filtervisiblesections.d.ts +4 -0
- package/dist/utils/findchangelogentrypaths.d.ts +4 -0
- package/dist/utils/findpackages.d.ts +4 -0
- package/dist/utils/generatechangelog.d.ts +4 -0
- package/dist/utils/getdateformatted.d.ts +4 -0
- package/dist/utils/groupentriesbysection.d.ts +4 -0
- package/dist/utils/modifychangelog.d.ts +4 -0
- package/dist/utils/movechangelogentryfiles.d.ts +4 -0
- package/dist/utils/parsechangelogentries.d.ts +4 -0
- package/dist/utils/promptreleasetype.d.ts +4 -0
- package/dist/utils/providenewversion.d.ts +4 -0
- package/dist/utils/removechangelogentryfiles.d.ts +4 -0
- package/dist/utils/truncatechangelog.d.ts +4 -0
- package/dist/utils/validateinputversion.d.ts +4 -0
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -393,7 +393,7 @@ function truncateChangelog(length, cwd) {
|
|
|
393
393
|
const truncatedEntries = entries.slice(0, length);
|
|
394
394
|
const repositoryUrl = workspaces.getRepositoryUrl(cwd);
|
|
395
395
|
const changelogFooter = entries.length > truncatedEntries.length ? `\n\n---\n\nTo see all releases, visit the [release page](${repositoryUrl}/releases).\n` : "\n";
|
|
396
|
-
saveChangelog(
|
|
396
|
+
saveChangelog("Changelog\n=========\n\n" + truncatedEntries.join("\n").trim() + changelogFooter, cwd);
|
|
397
397
|
}
|
|
398
398
|
function getChangelog(cwd) {
|
|
399
399
|
const changelogFile = upath.join(cwd, CHANGELOG_FILE);
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ConfigBase, GenerateChangelogEntryPoint, MonoRepoConfigBase } from "../types.js";
|
|
2
6
|
type MonoRepositoryConfig = ConfigBase & MonoRepoConfigBase & {
|
|
3
7
|
packagesDirectory: ConfigBase["packagesDirectory"];
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ConfigBase, GenerateChangelogEntryPoint } from "../types.js";
|
|
2
6
|
type SingleRepositoryConfig = Omit<ConfigBase, "packagesDirectory">;
|
|
3
7
|
export declare const generateChangelogForSingleRepository: GenerateChangelogEntryPoint<SingleRepositoryConfig>;
|
package/dist/template.d.ts
CHANGED
package/dist/template.js
CHANGED
|
@@ -4,15 +4,12 @@ import { exec } from "node:child_process";
|
|
|
4
4
|
import { cac } from "cac";
|
|
5
5
|
import path from "upath";
|
|
6
6
|
import { format } from "date-fns";
|
|
7
|
-
//#region src/utils/constants.ts
|
|
8
7
|
/**
|
|
9
8
|
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
10
9
|
* For licensing, see LICENSE.md.
|
|
11
10
|
*/
|
|
12
|
-
const VERSIONING_POLICY_URL = "https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html";
|
|
13
11
|
const CHANGESET_DIRECTORY = ".changelog";
|
|
14
12
|
const TEMPLATE_FILE = path.join(import.meta.dirname, "../template/template.md");
|
|
15
|
-
`${VERSIONING_POLICY_URL}`, `${VERSIONING_POLICY_URL}`;
|
|
16
13
|
//#endregion
|
|
17
14
|
//#region src/template.ts
|
|
18
15
|
/**
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ChangesetPathsWithGithubUrl } from "../types.js";
|
|
2
6
|
type RepositoryData = Pick<ChangesetPathsWithGithubUrl, "cwd" | "isRoot" | "filePaths">;
|
|
3
7
|
export declare function commitChanges(version: string, repositories: Array<RepositoryData>): Promise<void>;
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
export declare const CHANGELOG_FILE = "CHANGELOG.md";
|
|
2
6
|
export declare const CHANGELOG_HEADER = "Changelog\n=========";
|
|
3
7
|
export declare const NPM_URL = "https://www.npmjs.com/package";
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ChangelogReleaseType, SectionsWithEntries } from "../types.js";
|
|
2
6
|
export type DetermineNextVersionOptions = {
|
|
3
7
|
sections: SectionsWithEntries;
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { SectionsWithEntries, TransformScope } from "../types.js";
|
|
2
6
|
type DisplayChangesOptions = {
|
|
3
7
|
sections: SectionsWithEntries;
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ChangesetPathsWithGithubUrl, LinkFilter, RepositoryConfig } from "../types.js";
|
|
2
6
|
type FindChangelogEntryPathsOptions = {
|
|
3
7
|
cwd: string;
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ConfigBase, GenerateChangelogEntryPoint, MonoRepoConfigBase } from "../types.js";
|
|
2
6
|
type GenerateChangelogConfig = ConfigBase & MonoRepoConfigBase & {
|
|
3
7
|
isSinglePackage: boolean;
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
2
6
|
* Formats a date string `YYYY-MM-DD` into a human-readable format for the changelog.
|
|
3
7
|
*/
|
|
4
8
|
export declare function getDateFormatted(date: string): string;
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ParsedFile, SectionsWithEntries, TransformScope } from "../types.js";
|
|
2
6
|
type GroupEntriesBySectionOptions = {
|
|
3
7
|
files: Array<ParsedFile>;
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
2
6
|
* This function writes the generated changelog content to the repository's changelog file.
|
|
3
7
|
*
|
|
4
8
|
* It reads the existing changelog (if any), inserts the new changelog content after the defined header,
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ChangesetPathsWithGithubUrl } from "../types.js";
|
|
2
6
|
/**
|
|
3
7
|
* Moves changelog entry files to cycle-specific directories instead of deleting them.
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ChangesetPathsWithGithubUrl, ParsedFile } from "../types.js";
|
|
2
6
|
/**
|
|
3
7
|
* Reads and processes input files to extract changelog entries.
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import { type ReleaseType } from "semver";
|
|
2
6
|
import type { ChangelogReleaseType, ReleaseChannel } from "../types.js";
|
|
3
7
|
type Options = {
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
1
5
|
import type { ChangesetPathsWithGithubUrl } from "../types.js";
|
|
2
6
|
/**
|
|
3
7
|
* Cleans up the input files that have been incorporated into the changelog by deleting them
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
2
6
|
* This function limits the size of the changelog by removing older entries.
|
|
3
7
|
*/
|
|
4
8
|
export declare function truncateChangelog(length: number, cwd: string): void;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor5-dev-changelog",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "56.0.0",
|
|
4
4
|
"description": "A CKEditor 5 development tool for handling changelogs.",
|
|
5
5
|
"keywords": [],
|
|
6
6
|
"author": "CKSource (http://cksource.com/)",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"ckeditor5-dev-changelog-create-entry": "bin/generate-template.js"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@ckeditor/ckeditor5-dev-utils": "^
|
|
31
|
+
"@ckeditor/ckeditor5-dev-utils": "^56.0.0",
|
|
32
32
|
"cac": "^7.0.0",
|
|
33
33
|
"date-fns": "^4.1.0",
|
|
34
34
|
"glob": "^13.0.6",
|