{"id":21914449,"url":"https://github.com/vflopes/git-changelog","last_synced_at":"2026-04-06T08:02:07.813Z","repository":{"id":143829210,"uuid":"176771289","full_name":"vflopes/git-changelog","owner":"vflopes","description":"Smoothly create changelogs from commits","archived":false,"fork":false,"pushed_at":"2019-03-22T17:00:43.000Z","size":407,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T09:15:45.714Z","etag":null,"topics":["changelog","commit-hooks","commit-message","custom-commands","git"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/vflopes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-20T16:10:27.000Z","updated_at":"2024-09-04T16:52:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"b01a1d7b-86ed-416d-b9b6-8575abfcee8f","html_url":"https://github.com/vflopes/git-changelog","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/vflopes/git-changelog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vflopes%2Fgit-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vflopes%2Fgit-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vflopes%2Fgit-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vflopes%2Fgit-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vflopes","download_url":"https://codeload.github.com/vflopes/git-changelog/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vflopes%2Fgit-changelog/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31464115,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"online","status_checked_at":"2026-04-06T02:00:07.287Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","commit-hooks","commit-message","custom-commands","git"],"created_at":"2024-11-28T18:28:09.185Z","updated_at":"2026-04-06T08:02:07.796Z","avatar_url":"https://github.com/vflopes.png","language":"JavaScript","readme":"# git-changelog\n\nDo you ever wanted a tool to standardize your git commits? Also to generate the changelog based on commits? Here is **git-changelog**. This is a NodeJS project but we provide standalone builds that enhances the `git commit` command. You can use `git changelog` as you use `git commit` with the same arguments, except `-m`.\n\n![git-changelog](https://raw.githubusercontent.com/vflopes/git-changelog/master/changelog.gif)\n\n-----------------------------\n\n### Installation\n\n1. Go to [releases](https://github.com/vflopes/git-changelog/releases)\n2. Download the version that fits your system and extract the executable file where you can keep the executable forever\n3. Run the executable with `-i` option, example: `./git-changelog-linux-x64 -i`\n4. Now you have the `git changelog` command\n\nIf you have a problem when executing the file on Linux/MacOS do a `chmod +x git-changelog-YOUROS/ARCH` before executing it.\n\n-----------------------------\n\n### Customization\n\nWhen you run `git changelog` the command will look for a **.gitchangelog** file in the current directory of the execution. The default **.gitchangelog** if there's no file or attribute is explained bellow.\n\n```json\n{\n   \"changelogFilename\": \"CHANGELOG.md\",\n   \"changelogTemplate\": \"default\",\n   \"commitTemplate\": \"karma\",\n   \"types\": {\n      \"feat\": \"new feature for the user, not a new feature for build script\",\n      \"fix\": \"bug fix for the user, not a fix to a build script\",\n      \"docs\": \"changes to the documentation\",\n      \"style\": \"formatting, missing semi colons, etc; no production code change\",\n      \"refactor\": \"refactoring production code, eg. renaming a variable\",\n      \"test\": \"adding missing tests, refactoring tests; no production code change\",\n      \"chore\": \"updating grunt tasks etc; no production code change\"\n   },\n   \"scopes\": [],\n   \"labels\": [\n      \"action\",\n      \"version\"\n   ],\n   \"beforeCommit\": [],\n   \"afterCommit\": []\n}\n```\n\n-----------------------------\n\n##### changelogFilename\n\nThe name of the changelog file.\n\n-----------------------------\n\n##### changelogTemplate\n\nThe changelog template. All templates are executed with [doT](http://olado.github.io/doT/index.html) syntax and you have the following properties from the `it` var:\n\n```js\n{\n   \"type\": null, // string with type\n   \"scope\": null, // string with scope\n   \"subject\": null, // string with subject\n   \"body\": null, // null or array with the changes as strings\n   \"labels\": null // object with key-value labels\n}\n```\n\nThe **default** changelog template is placed at **/templates/changelog** path of this repo. You can specify a **doT** template in this attribute to customize the changelog entries.\n\n-----------------------------\n\n##### commitTemplate\n\nThe commit (`git -m \"[commitMessage]\"`) template. This template follows the same approach of `changelogTemplate` except that are two available options instead of **default**:\n\n- [karma](http://karma-runner.github.io/3.0/dev/git-commit-msg.html)\n- [bitbucket](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html)\n\n-----------------------------\n\n##### types\n\nA key-value object with allowed types. The default pairs comes from **karma**. The description is shown when the user type `git changelog --help`. Can also be a string with that points to a known preset, allowed values are:\n\n- `karma`\n- `atom`\n\n-----------------------------\n\n##### scopes\n\nAn array with allowed scopes or leave it empty to allow user enter a custom scope.\n\n-----------------------------\n\n##### labels\n\nAn array with allowed labels to create custom markers for each commit. The user will input a value for each label.\n\n-----------------------------\n\n##### beforeCommit\n\nAn array with commands to execute before the commit and changelog update, if the command exits with a code different from 0 then the `git changelog` will exit with the same code.\n\n-----------------------------\n\n##### afterCommit\n\nAn array with commands to execute after the commit and changelog update, if the command exits with a code different from 0 then the `git changelog` will exit with the same code.\n\n-----------------------------\n\n### Testing\n\nThe tests are built with mocha and chai, you can run with the following command:\n\n```\nnpm run test\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvflopes%2Fgit-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvflopes%2Fgit-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvflopes%2Fgit-changelog/lists"}