Skip to content

Package

ChangelogGenerator can be imported in any javascript or typescript project.

It can be installed by running: npm install @dotcircle/changelog-generator.
The project is hosted on the dotcircle forgejo instance https://git.dotcircle.dev .
In order to point npm to the right location, add the following entry in your .npmrc:

@dotcircle:registry=https://git.dotcircle.dev/api/packages/dotcircle.co/npm/

As an example:

import { ChangelogGenerator } from '@dotcircle/changelog-generator';
const generator = new ChangelogGenerator('../CHANGELOG.yml');
generator.setCount(1); // to only include the specified release
generator.setVersion('1.0.2'); // to set the version (default is the latest)
const markdown = generator.markdown();