{"id":32161627,"url":"https://github.com/getshoptv/changelogged","last_synced_at":"2025-10-21T13:56:44.217Z","repository":{"id":62435693,"uuid":"102854767","full_name":"GetShopTV/changelogged","owner":"GetShopTV","description":"Changelog manager for Git projects.","archived":false,"fork":false,"pushed_at":"2018-08-23T15:39:19.000Z","size":13369,"stargazers_count":4,"open_issues_count":14,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-21T13:56:37.493Z","etag":null,"topics":["bumpversion","changelog","git-flow"],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GetShopTV.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":"2017-09-08T11:33:27.000Z","updated_at":"2018-08-23T15:34:11.000Z","dependencies_parsed_at":"2022-11-01T21:00:55.704Z","dependency_job_id":null,"html_url":"https://github.com/GetShopTV/changelogged","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/GetShopTV/changelogged","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetShopTV%2Fchangelogged","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetShopTV%2Fchangelogged/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetShopTV%2Fchangelogged/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetShopTV%2Fchangelogged/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GetShopTV","download_url":"https://codeload.github.com/GetShopTV/changelogged/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetShopTV%2Fchangelogged/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280272339,"owners_count":26302260,"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","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"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":["bumpversion","changelog","git-flow"],"created_at":"2025-10-21T13:56:40.484Z","updated_at":"2025-10-21T13:56:44.209Z","avatar_url":"https://github.com/GetShopTV.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# changelogged\n\n[![Hackage](https://img.shields.io/hackage/v/changelogged.svg)](http://hackage.haskell.org/package/changelogged)\n[![Build Status](https://travis-ci.org/GetShopTV/changelogged.svg?branch=master)](https://travis-ci.org/GetShopTV/changelogged)\n\n`changelogged` is a changelog manager for Git projects.\n\n![`changelogged` demo.](images/demo_new.gif)\n\n## Quick start\n\nYou're encouraged to use `changelogged` when preparing a new release of your project.\n\nIf you're using bash you probably want to enable autocompletion. You can do it with the following or equivalent:\n```\nchangelogged --bash-completion-script changelogged \u003e\u003e ~/.bash_completion\n```\nIn new terminal sessions you will have it.\n\nFor most projects you can simply run `changelogged` with no options or configuration files:\n\n```\nchangelogged\n```\n\nAfter you refuse to do to interactive mode it will add missing entries to your changelogs and open editor for each if them.\n\nBy default editor is set by `$EDITOR` variable.\n\nAfter you can bummp versions over whole project (usable if you have more than one version file).\n\nThat's it! Now you have a proper changelog with no forgotten changes.\n\n### A note for Git Flow projects\n\nWith Git Flow your development and feature branches\nwill likely not have version tags associated with them.\nThis can confuse `changelogged` and result in more suggestions than needed.\n\nTo avoid this situation add [`branch: master` line](https://github.com/GetShopTV/changelogged/blob/master/.changelogged.template.yaml#L37-L41)\nin your `.changelogged.yaml`.\n\n## Versioning\n\nLet A.B.C.D.E be version number.\n\nThey are named in a prompt correspondingly `app`, `major`, `minor`, `fix` and `doc`\n\nA.B.C versions are bumped through zero. If you have version A.B.9 and bump B next version will be A.B+1.0.\nA.B version will never be reached since C was introduced once.\n\nnon-PVP versions are bumped through one. A.B.C.9 -\u003e A.B.C+1 -\u003e A.B.C+1.1\n\n## Configuration file\n\nFor any non-trivial project you're likely to want to configure the way `changelogged`\ntreats changes in that project.\nNormally configuration file is located at `.changelogged.yaml` in the root of the project. (note the leading dot).\nYou can define your own location with option `--config`.\n\nSee [.changelogged.template.yaml](.changelogged.template.yaml)\nfor a template configuration file with description of all fields.\nAll paths inside can be relative against project root directory.\n\n## Interactive mode\n\n![`changelogged` demo.](images/demo_interactive.gif)\n\nIf you want a lot more customized changelog try to go to interactive mode.\n\nIt allows to walk through history and do something with each entry.\nOptions:\n * `(w)rite` - write entry to changelog and go to next. You can omit `w` and do it by pressing enter.\n * `(r)emind` - show commit in pager.\n * `(s)kip` - skip entry and go to next.\n * `(e)xpand` - write merge commit entry, expand to subchanges and walk through them.\n * `(i)gnore` - ignore commit. It will be written to config and will never be suggested as missing.\n * `(a)ll` - add remaining entries to changelog. Raised inside merge commit it will add rest of subchanges.\n * `(q)uit` - skip remaining entries. Inside merge commit it will quit it only.\n\n### Help message\n\n```\nchangelogged --help\n```\n\n```\nChangelog Manager for Git Projects\n\nUsage: changelogged [--dry-run] [TARGET_CHANGELOG]\n                    [--config changelogged.yaml config file location]\n  Changelogged\n\nAvailable options:\n  -h,--help                Show this help text\n  --list-misses            List missing entries, don't modify changelogs.\n  --from-version CHECK_FROM_TAG\n                           Tag or commit from which to check changelogs.\n  --from-beginning         Check all changelogs from start of the project.\n  --no-colors              Print all messages in standard terminal color.\n  --dry-run                Do not change files while running.\n  TARGET_CHANGELOG         Path to target changelog.\n  --config changelogged.yaml config file location\n                           Path to config file.\n  --verbose                Turn verbose mode on (useful for developers).\n  --version                Print version.\n\n```\n\n## Getting and building\n\n### Requirements\n\nIt works with Git projects only.\n\nCurrent version supports only GitHub and UNIX like OS.\nWe are working on it.\n\n#### Installing from Hackage\n\nYou can build a version from Hackage using Stack or cabal-install:\n\n```\nstack install changelogged\n```\n\n```\ncabal install changelogged\n```\n\n#### Using latest code from GitHub\n\nClone this repository:\n\n```\ngit clone https://github.com/GetShopTV/changelogged.git\n```\n\n`cd` into cloned repository and build with Stack:\n\n```\nstack build\n```\n\nYou can now run `changelogged` via Stack with\n\n```\nstack exec changelogged\n```\n\nor you can install it with\n\n```\nstack install\n```\n\n## Contributing\n\nBug reports and feature requests are welcome on\n[GitHub](https://github.com/GetShopTV/changelogged/issues)\n\nCode of conduct and contributing rules are coming soon.\n\nPull requests are welcome!\n\n_GetShop.TV Team_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetshoptv%2Fchangelogged","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetshoptv%2Fchangelogged","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetshoptv%2Fchangelogged/lists"}