{"id":15759373,"url":"https://github.com/pegasd/keepthechange","last_synced_at":"2025-03-31T09:10:38.394Z","repository":{"id":56879977,"uuid":"98730868","full_name":"pegasd/keepthechange","owner":"pegasd","description":"Parse CHANGELOGs","archived":false,"fork":false,"pushed_at":"2017-12-21T21:12:34.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-26T08:20:45.696Z","etag":null,"topics":["changelog"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/pegasd.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}},"created_at":"2017-07-29T12:23:59.000Z","updated_at":"2017-07-29T19:31:25.000Z","dependencies_parsed_at":"2022-08-20T23:40:12.090Z","dependency_job_id":null,"html_url":"https://github.com/pegasd/keepthechange","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasd%2Fkeepthechange","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasd%2Fkeepthechange/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasd%2Fkeepthechange/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pegasd%2Fkeepthechange/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pegasd","download_url":"https://codeload.github.com/pegasd/keepthechange/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246443536,"owners_count":20778249,"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"],"created_at":"2024-10-04T10:04:58.126Z","updated_at":"2025-03-31T09:10:38.373Z","avatar_url":"https://github.com/pegasd.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KeepTheChange\n\n[![Gem Version](https://badge.fury.io/rb/keepthechange.svg)](https://badge.fury.io/rb/keepthechange)\n[![Build Status](https://travis-ci.org/pegasd/keepthechange.svg?branch=master)](https://travis-ci.org/pegasd/keepthechange)\n[![Coverage Status](https://coveralls.io/repos/github/pegasd/keepthechange/badge.svg)](https://coveralls.io/github/pegasd/keepthechange)\n\nThis gem provides an easy-to-use interface for parsing CHANGELOG files that strictly adhere to\n[keep a changelog format](http://keepachangelog.com/).\n\nThe idea is loosely based on [vandamme](https://github.com/tech-angels/vandamme) gem, but is supposed to evolve\ninto something more strict (in terms of supported formats), but also more feature-rich.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'keepthechange'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n\n```bash\n$ gem install keepthechange\n```\n\n## Usage\n\n### Parsed Changes Hash\n\n```ruby\nparser = KeepTheChange::Parser.new(changelog: File.read('CHANGELOG.md'))\nchanges_hash = parser.parse\n```\n\nThis will produce a hash where keys are version numbers (e.g. `0.1.0`, `1.0.3`) and values are hashes themselves.\nThose will have headers as keys (e.g. `Added`, `Fixed`) and changesets as corresponding values.\n\n### Combine Multiple Changesets\n\nIf you only provide one argument to `combine_changes()`, the resulting output will contain changes since that\nversion.\n\n```ruby\nFile.write('SINCE_0.1.7.md', parser.combine_changes('0.1.7'))\n```\n\n\u003e `0.1.7` itself won't be included in the resulting file.\n\nSpecify both the lower and upper bound (again - lower bound is exclusive) to produce output with changes between the versions.\n\n```ruby\nFile.write('0.1.7-1.0.3.md', parser.combine_changes('0.1.7', '1.0.3'))\n```\n\n## Development\n\nAfter checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also \nrun `bin/simple_test` after putting a `TEST_CHANGELOG.md` into the repo directory for a basic parsing test.\n\nTo install this gem onto your local machine, run `bundle exec rake install`.\n\n## Contributing\n\nBug reports, feature requests and pull requests are welcome at [KeepTheChange official repo](https://github.com/pegasd/keepthechange).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Keepthechange project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the \n[Code of Conduct](https://github.com/pegasd/keepthechange/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpegasd%2Fkeepthechange","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpegasd%2Fkeepthechange","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpegasd%2Fkeepthechange/lists"}