🚀 Configuration

This package uses conventional commits as a base for constructing the changelog, make sure your commits follow this pattern.

Create a changelog.config.json in your root directory and provide the link for your project's commits, issues(optional) and changelog name(optional).

Configuration file example:

{
    "commits_dir": "https://github.com/user/repository/commit",
    "issues_dir": "https://github.com/user/repository/issues",
    "changelog_name": "CHANGELOG_CUSTOM_NAME"
}

Or configure your workspace with the command line:

npx versionator-js init

or

npm install versionator-js -g
versionator-js init

🚨 Running versionator-js in your project.

npm install versionator-js

AND

const versionator = require('versionator-js')

versionator.build()

OR

npx versionator-js

OR

npm install versionator-js -g

versionator-js

📚 Additional Instructions

For issues to be used sucessfully, the issue identifier should be provided as "(#ISSUE_TAG)" at the commit body.

Commit with issue example: "feat: add some components (#ISSUE-90)".

♻️ Contributing

Keep in mind that it is still an ongoing project at its beginning, pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

🚧 License

ISC