Generating a changelog for a monorepository

[martnpaneq]

Suggested merge commit message (convention)

Feature: Generating a changelog for a monorepository. Closes ckeditor/ckeditor5#18063.

---

Additional information

For example – encountered issues, assumptions you had to make, other affected tickets, etc.

[coveralls]

coverage: 88.04% (-0.005%) from 88.045%
when pulling 18a789e on ck/18063-changelog-for-monorepository
into 8ed77ce on epic/ck/18051-changeset.

[psmyrek]

First review part.

[psmyrek]

Please merge master branch to epic branch and ck/18063-changelog-for-monorepository.

[psmyrek]

Is the lack of bin intentional?

[psmyrek]

When there is no .changelog directory, the following code:

It seems that current implementation expects that at least one major and at least one minor breaking change is found.
When there is no items without major and minor breaking changes, the following code:

import { generateChangelog } from '@ckeditor/ckeditor5-dev-changelog';

generateChangelog( {
    cwd: process.cwd()
} );

throws an error:

� Listing the changes...

� Determining the new version...

file:///D:/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/ckeditor5-dev-changelog/dist/index.js:427
    if (sectionsWithEntries.minor.entries.length || sectionsWithEntries.Feature.entries.length) {
                                          ^

TypeError: Cannot read properties of undefined (reading 'length')
    at getNewVersion (file:///D:/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/ckeditor5-dev-changelog/dist/index.js:427:43)
    at generateChangelog (file:///D:/Projects/ckeditor/ckeditor5/external/ckeditor5-dev/packages/ckeditor5-dev-changelog/dist/index.js:633:45)

[psmyrek]

Found a few things to consider. Other than that, LGTM.

1. Blank line after the version question?

   ○ Determining the new version...
   
   ✔ Type the new version (current: "44.3.0", suggested: "45.0.0"): 45.0.0
   ○ Appending changes to the existing changelog...
   ○ Removing the changeset files...
   

2. The generated changelog contains a space after the entry, but the source changeset file does not have it:

   

[psmyrek]

Please sort dependencies alphabetically.

[psmyrek]

Two proposals:

• The cwd option could also have default value, so you don't have to specify process.cwd() in 5 other places.
• Options with default values could be listed at the end to quickly find out what is required and what may be skipped.

[psmyrek]

What if we would like to skip links in the generated changelog for the root repository, e.g. when the repository is private?

[psmyrek]

This line is not consistent with others places:

externalRepositories.map( externalRepository => … )

externalRepositories.map( repo => … )

[psmyrek]

The findPathsToPackages() function is always called with includePackageJson = true, so maybe this option could be removed.

[psmyrek]

A few utils are not mocked: getDateFormatted, defaultTransformScope, getExternalRepositoriesWithDefaults.

[psmyrek]

It seems that vi.clearAllMocks() is not needed, as we have test.restoreMocks = true in vitest.config.ts.

[psmyrek]

From my point of view it is not needed to mock upath. Let's treat this as an external library, like lodash.

[psmyrek]

It produces paths with backslashes on Windows which are not clickable:

 ◌ Found Invalid changes:
    - "Message." (file://D:\Projects\ckeditor\ckeditor5\.changelog\1.md)

[psmyrek]

This proposal #1090 (comment) should fix it.

[psmyrek]

It would be nice to normalize all paths. On Windows glob returns paths with backslash separators.