conventional-changelog
Generate changelogs and release notes from a project's commit messages and metadata.
File Explorer
Download Latest Version (.zip)- checks.yml
- commit.yml
- release.yml
- tests.yaml
- website.yml
- renovate.json
- cli.ts
- index.spec.ts
- index.ts
- options.ts
- utils.ts
- bitbucket.ts
- github.ts
- gitlab.ts
- index.ts
- better-than-before.d.ts
- ConventionalChangelog.spec.ts
- ConventionalChangelog.ts
- index.ts
- types.ts
- utils.ts
- _CHANGELOG.md
- _host-only.json
- _malformation.json
- _package.json
- _short.json
- _unknown-host.json
- _version-only.json
- config.cjs
- context.json
- promise-config.cjs
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- index.d.ts
- index.js
- parser.js
- templates.js
- whatBump.js
- writer.js
- _ghe-host.json
- _known-host.json
- _unknown-host.json
- index.spec.js
- legacyWriter.spec.js
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- constants.js
- format.js
- index.d.ts
- index.js
- parser.js
- templates.js
- utils.js
- whatBump.js
- writer.js
- _ghe-host.json
- _known-host.json
- _unknown-host.json
- index.spec.js
- legacyWriter.spec.js
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- index.ts
- presetLoader.spec.ts
- presetLoader.ts
- types.ts
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- index.spec.ts
- index.ts
- utils.ts
- index.ts
- options.ts
- utils.ts
- commit.spec.ts
- commit.ts
- context.spec.ts
- context.ts
- index.ts
- options.ts
- template.spec.ts
- template.ts
- utils.spec.ts
- utils.ts
- writers.spec.ts
- writers.ts
- commits.ldjson
- context.json
- invalid_line_delimited.json
- options.cjs
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- filters.spec.ts
- filters.ts
- index.ts
- RevertedCommitsFilter.ts
- types.ts
- utils.ts
- CHANGELOG.md
- LICENSE
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- index.spec.ts
- index.ts
- options.ts
- utils.ts
- CommitParser.spec.ts
- CommitParser.ts
- index.ts
- options.ts
- regex.spec.ts
- regex.ts
- stream.spec.ts
- stream.ts
- types.ts
- utils.ts
- bad_commit.txt
- log1.txt
- log2.txt
- log3.txt
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- index.ts
- options.ts
- utils.ts
- better-than-before.d.ts
- bumper.spec.ts
- bumper.ts
- index.ts
- types.ts
- utils.ts
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- ConventionalGitClient.spec.ts
- ConventionalGitClient.ts
- GitClient.spec.ts
- GitClient.ts
- index.ts
- types.ts
- utils.spec.ts
- utils.ts
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- cli.spec.ts
- cli.ts
- globals.d.ts
- index.spec.ts
- index.ts
- _CHANGELOG.md
- _package.json
- config.cjs
- context.json
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- commit.ts
- context.ts
- index.ts
- utils.ts
- elements.ts
- index.ts
- legacy.spec.ts
- legacy.ts
- references.spec.ts
- references.ts
- templates.spec.ts
- templates.ts
- CHANGELOG.md
- LICENSE.md
- oxlint.config.ts
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- SKILL.md
- commit.ts
- index.ts
- oxlint.config.ts
- TestTools.ts
- through.ts
- tmp.ts
- tsconfig.json
- utils.ts
- favicon.svg
- og-image.jpg
- robots.txt
- changelog.png
- commitizen.gif
- commits.png
- pr.png
- release.png
- changelog-dark.svg
- changelog-light.svg
- api.mdx
- cli.mdx
- index.mdx
- api.mdx
- index.mdx
- api.mdx
- index.mdx
- api.mdx
- cli.mdx
- index.mdx
- agent-skills.mdx
- complete-guide.mdx
- index.mdx
- api.mdx
- index.mdx
- index.mdx
- index.mdx
- options.mdx
- index.mdx
- options.mdx
- api.mdx
- cli.mdx
- index.mdx
- index.mdx
- api.mdx
- cli.mdx
- index.mdx
- index.mdx
- global.css
- content.config.ts
- env.d.ts
- astro.config.js
- oxlint.config.ts
- package.json
- rehype.js
- tsconfig.json
- .clean-publish
- .commitlintrc.js
- .czrc
- .editorconfig
- .gitattributes
- .gitignore
- .nano-staged.json
- .simple-git-hooks.json
- .simple-release.js
- .tool-versions
- LICENSE.md
- meta.md
- oxlint.config.ts
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- tsconfig.json
- vite.config.js
π Installation Guide
1. Get the code
git clone https://github.com/conventional-changelog/conventional-changelog
Downloads the entire project code from GitHub to your computer.
cd conventional-changelog
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)
