{"id":15821424,"url":"https://github.com/excalith/changeling","last_synced_at":"2025-04-01T06:38:34.463Z","repository":{"id":97288360,"uuid":"151290335","full_name":"excalith/changeling","owner":"excalith","description":"Generates changelogs between commit hashes and creates a clean markdown file sections from commit message prefixes","archived":false,"fork":false,"pushed_at":"2018-10-15T16:09:30.000Z","size":6204,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-12T07:50:01.587Z","etag":null,"topics":["app","changelog","changelog-formatter","changelog-generator","git","node","screenshot","terminal-app"],"latest_commit_sha":null,"homepage":"","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/excalith.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-02T16:53:29.000Z","updated_at":"2018-10-15T16:09:16.000Z","dependencies_parsed_at":"2023-06-07T20:45:37.957Z","dependency_job_id":null,"html_url":"https://github.com/excalith/changeling","commit_stats":{"total_commits":11,"total_committers":2,"mean_commits":5.5,"dds":0.09090909090909094,"last_synced_commit":"528cd686e2bf2e147e5d0305a27a8ae610b576af"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/excalith%2Fchangeling","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/excalith%2Fchangeling/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/excalith%2Fchangeling/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/excalith%2Fchangeling/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/excalith","download_url":"https://codeload.github.com/excalith/changeling/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246598153,"owners_count":20802973,"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":["app","changelog","changelog-formatter","changelog-generator","git","node","screenshot","terminal-app"],"created_at":"2024-10-05T07:22:10.706Z","updated_at":"2025-04-01T06:38:34.436Z","avatar_url":"https://github.com/excalith.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\t\u003ch1 align=\"center\"\u003eChangeling - \u003ci\u003eA Changelog Generator\u003c/i\u003e\u003c/h1\u003e\n\u003c/p\u003e\n\u003cp align = \"center\"\u003e\n    Generates changelogs between commit hashes and creates a clean markdown file with commit prefix sections\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"screenshot.gif\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\t\u003ca href=\"https://travis-ci.org/excalith/changeling\"\u003e\n\t\t\u003cimg alt=\"Build Status\" height=\"18\" src=\"https://img.shields.io/travis/excalith/changeling.svg\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://github.com/excalith/changeling/issues\"\u003e\n\t\t\u003cimg alt=\"Build Status\" height=\"18\" src=\"https://img.shields.io/github/issues/excalith/changeling.svg\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://github.com/excalith/changeling/stargazers\"\u003e\n\t\t\u003cimg alt=\"Stars\" height=\"18\" src=\"https://img.shields.io/github/stars/excalith/changeling.svg\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://github.com/excalith/changeling/network\"\u003e\n\t\t\u003cimg alt=\"Forks\" height=\"18\" src=\"https://img.shields.io/github/forks/excalith/changeling.svg\"\u003e\n\t\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr/\u003e\n\n**Changeling** helps you to generate changelogs between commit hashes easily. Depending on your commit message prefixes, your changelog will be created with markdown sections and commit messages with corresponding hashes.\n\n## How To Install:\n\n- Requirements\n  - [NodeJS](https://nodejs.org)\n  - [NPM](https://www.npmjs.com/get-npm)\n- Clone or Download this repository\n- Within the directory, from your favorite terminal\n  - `npm install`\n  - `npm link` (might ask for permission depending on your OS)\n- Now you can use `clog` or `changelog` right from your terminal!\n\n## How To Use:\nIn order to use the app, please follow **How To Install** steps above.\n\nWhen you complete installation, you can run commands below\n\n### Available Commands:\n| _Command_ | _Description_                |\n| --------- | ---------------------------- |\n| clog      | Run Changeling               |\n| clog -s   | Open Settings File In Editor |\n| clog -h   | Display This Help            |\n\n### Generating Log File\nWhenever you run `clog` app will run by default. You need to fill required fields to generate your changelog. When you are done, changelog will be saved in your git directory.\n\n| _Settings_       | _Description_                                                                       |\n| ---------------- | ----------------------------------------------------------------------------------- |\n| Title            | Title for your new changelog (ie. Milestone 5)                                      |\n| From Commit Hash | Pick from which commit you want to include commits                                  |\n| To Commit Hash   | Pick which commit you want to end fetching commits                                  |\n| Append or Create | If you generated a changelog before, you can append to it or create a new changelog |\n| Check Settings   | Check your settings before creating                                                 |\n\n\n### Settings\nYou can update settings by using `clog -s` command. This will open config file within your beloved editor.\nDefault Settings:\n\n| _Key_           | _Value_      |\n| --------------- | ------------ |\n| prefixes        | Add          |\n|                 | Remove       |\n|                 | Improve      |\n|                 | Change       |\n|                 | Update       |\n|                 | Refactor     |\n|                 | Fix          |\n| defaultFileName | Changelog.md |\n| tempFileName    | tempLog.txt  |\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexcalith%2Fchangeling","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexcalith%2Fchangeling","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexcalith%2Fchangeling/lists"}