Skip to content

Commit 4f8215d

Browse files
committed
Final touches.
1 parent fee8a26 commit 4f8215d

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

packages/ckeditor5-dev-changelog/README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,43 @@ CKEditor 5 Changelog
44
[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-dev-changelog.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-changelog)
55
[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5-dev.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-dev?branch=master)
66

7-
A development tool for handling changelogs in CKEditor 5.
7+
A development tool for handling the changelog preparation in CKEditor 5.
8+
9+
## Installation
10+
11+
Install the package to use it.
12+
13+
```
14+
npm i --save-dev @ckeditor/ckeditor5-dev-changelog
15+
```
816

917
## API
1018

11-
This package can be used via the JavaScript API.
19+
This package provides a command-line interface (CLI) and a JavaScript API for generating changelogs.
20+
21+
### Binary scripts
22+
23+
The `ckeditor5-dev-changelog-create-entry` script allows you to create a new changelog entry. By default, it will be created in the
24+
`.changelog/` directory.
1225

1326
### JavaScript API
1427

15-
The JavaScript API can be used as follows:
28+
The JavaScript/TypeScript API can be used as follows:
1629

17-
```javascript
18-
import { generateChangelog } from '@ckeditor/ckeditor5-dev-changelog';
30+
```ts
31+
import { generateChangelogForMonoRepository, generateChangelogForSingleRepository } from '@ckeditor/ckeditor5-dev-changelog';
1932

20-
generateChangelog();
33+
await generateChangelogForMonoRepository( { /* options */ } );
34+
await generateChangelogForSingleRepository( { /* options */ } );
2135
```
2236

37+
Review the types to see the available options.
38+
2339
## Changelog
2440

2541
See the [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-changelog/CHANGELOG.md) file.
2642

2743
## License
2844

29-
Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file.
45+
Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about
46+
the license, please check the `LICENSE.md` file.

packages/ckeditor5-dev-changelog/template/template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
# - Other
77
# - Major breaking change
88
# - Minor breaking change
9-
# - Breaking change
109
#
1110
# For guidance on breaking changes, see:
1211
# https://ckeditor.com/docs/ckeditor5/latest/updating/versioning-policy.html#major-and-minor-breaking-changes
1312
type:
1413

1514
# Optional: Affected package(s), using short names.
15+
# Can be skipped when processing a non-mono-repository.
1616
# Example: ckeditor5-core
1717
scope:
1818
-
@@ -35,7 +35,7 @@ see:
3535

3636
# Optional: Community contributors.
3737
# Format:
38-
# - @{github-username}
38+
# - {github-username}
3939
communityCredits:
4040
-
4141
---

0 commit comments

Comments
 (0)