{"id":15706743,"url":"https://github.com/ydcjeff/chlog","last_synced_at":"2025-05-12T15:44:15.454Z","repository":{"id":44614077,"uuid":"443711787","full_name":"ydcjeff/chlog","owner":"ydcjeff","description":"Universal changelog generator using conventional commit+ with monorepo support. Written in Rust.","archived":false,"fork":false,"pushed_at":"2022-02-04T14:42:26.000Z","size":276,"stargazers_count":5,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T14:42:41.676Z","etag":null,"topics":["changelog","changelog-generator","conventional-changelog","conventional-commits","git","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ydcjeff.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-02T07:55:43.000Z","updated_at":"2023-01-21T12:53:28.000Z","dependencies_parsed_at":"2022-09-02T04:02:53.291Z","dependency_job_id":null,"html_url":"https://github.com/ydcjeff/chlog","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydcjeff%2Fchlog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydcjeff%2Fchlog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydcjeff%2Fchlog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydcjeff%2Fchlog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ydcjeff","download_url":"https://codeload.github.com/ydcjeff/chlog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253767477,"owners_count":21961115,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog","changelog-generator","conventional-changelog","conventional-commits","git","rust"],"created_at":"2024-10-03T20:27:32.689Z","updated_at":"2025-05-12T15:44:15.424Z","avatar_url":"https://github.com/ydcjeff.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chlog\n\n\u003cp\u003e\n  \u003ca href=\"https://github.com/ydcjeff/chlog/actions/workflows/ci.yml\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://github.com/ydcjeff/chlog/actions/workflows/ci.yml/badge.svg\" alt=\"CI status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/chlog\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/crates/v/chlog\" alt=\"crate version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/chlog\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/crates/d/chlog\" alt=\"crate total download\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003e Universal changelog generator using conventional commit+ with monorepo\n\u003e support.\n\n[![demo](https://raw.githubusercontent.com/ydcjeff/chlog/main/.github/screenshot.png)](https://github.com/ydcjeff/chlog/blob/main/.github/screenshot.png?raw=true)\n\n**chlog** can generate the changelog from the conventional commits with a few\nextra commit types. The supported commit types are:\n\n- `fix` -\u003e Bug Fixes\n- `deps` -\u003e Dependency Updates\n- `deprecate` -\u003e Deprecations (Deprecations are important for users as putting\n  under refactor is hard to find)\n- `dx` -\u003e Developer Experience\n- `docs` -\u003e Documentation\n- `feat` -\u003e Features\n- `perf` -\u003e Performance Improvements\n- `refactor` -\u003e Refactoring\n\nIf there is `!` after the commit types or commit scope, those commits will be\nunder BREAKING CHANGES section.\n\n## Installation\n\nBinary releases can be downloaded at\n[GitHub release page](https://github.com/ydcjeff/chlog/releases/latest) or if\nyou want to install with `cargo`:\n\n```sh\ncargo install chlog\n```\n\n## Usage\n\n**chlog** has command line options for generating and prepending changelogs.\n\nFor the first release, you can run with:\n\n```sh\nchlog -o CHANGELOG.md -r 0 -t v0.1.0\n```\n\nFor the subsequent release,\n\n```sh\nchlog -o CHANGELOG.md -t v0.2.0\n```\n\nFor the packages with monorepo, you can use `commit-path` option. It will\ngenerate the changelog scoped to that package.\n\n```sh\nchlog -o CHANGELOG.md -t v0.3.0 -r 2 --commit-path crates/scope-crate\n```\n\nCLI:\n\n```console\n  chlog\n\n  Description:\n    Universal changelog generator using conventional commit+\n    with monorepo support\n\n  Usage:\n    $ chlog [options]\n\n  Example:\n    $ chlog -o CHANGELOG.md -t v1.0.0\n    $ chlog -o CHANGELOG.md -t v1.0.0\n    $ chlog -o CHANGELOG.md -t v1.0.0 -r 2\n    $ chlog -o CHANGELOG.md -t v1.0.0 -r 2 --commit-path crates/scope-crate\n\n  Options:\n    -t  \u003cstring\u003e          Tag name for the next release\n    -r  \u003cnumber\u003e          Number of releases to generate the changelog\n                          If 0, the whole changelog will be generated\n                          (i.e. first release) (default: 1)\n    -o  \u003cfile\u003e            File to write the generated changelog\n                          It will prepend the changelogs if the file exists\n                          otherwise, will create a new one\n    --commit-path \u003cpath\u003e  Generate a changelog scoped to a specific directory\n\n  Flags:\n    -h, --help            Show this message\n    -V, --version         Show version number\n\n  Source: https://github.com/ydcjeff/chlog\n```\n\n## Contribution\n\n- Make sure you have installed [Rust](https://www.rust-lang.org/tools/install).\n- Setup git hook\n\n  ```sh\n  git config core.hookspath .githooks\n  ```\n\n## LICENSE\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydcjeff%2Fchlog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fydcjeff%2Fchlog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydcjeff%2Fchlog/lists"}