{"id":19987468,"url":"https://github.com/schibsted/pr_changelog","last_synced_at":"2026-03-08T05:33:39.486Z","repository":{"id":34037778,"uuid":"166401356","full_name":"schibsted/pr_changelog","owner":"schibsted","description":"A script to generate a nice list of changes given two git references.","archived":false,"fork":false,"pushed_at":"2022-04-01T09:15:22.000Z","size":73,"stargazers_count":6,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-11-10T06:16:40.894Z","etag":null,"topics":["changelog-generator","github","ruby-gem"],"latest_commit_sha":null,"homepage":null,"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/schibsted.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-18T12:25:38.000Z","updated_at":"2023-03-03T11:44:19.000Z","dependencies_parsed_at":"2022-08-07T23:31:33.827Z","dependency_job_id":null,"html_url":"https://github.com/schibsted/pr_changelog","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/schibsted/pr_changelog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schibsted%2Fpr_changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schibsted%2Fpr_changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schibsted%2Fpr_changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schibsted%2Fpr_changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schibsted","download_url":"https://codeload.github.com/schibsted/pr_changelog/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schibsted%2Fpr_changelog/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30246740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T00:58:18.660Z","status":"online","status_checked_at":"2026-03-08T02:00:06.215Z","response_time":56,"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-generator","github","ruby-gem"],"created_at":"2024-11-13T04:36:27.398Z","updated_at":"2026-03-08T05:33:39.457Z","avatar_url":"https://github.com/schibsted.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PR Changelog\n\n[![Gem Version](https://badge.fury.io/rb/pr_changelog.svg)](https://badge.fury.io/rb/pr_changelog)\n\nA script to generate a nice list of changes given two git references, like so:\n\n```markdown\n## Changes since 0.3.0 to 0.5.0\n\n[New features]\n  - #61: ⭐️ Shake the phone to send feedback email\n\n[Improvements]\n  - #64: 💎 Visual refinements for canvas 2.0\n  - #57: 💎 Memory performance tweaks\n  - #62: 💎 Visual polishing for top stories\n\n[Internal]\n  - #65: 👨‍💻 Add formatting rules for xml files\n  - #60: 👨‍💻 Setup hockeyapp for crash reporting\n```\n\nIt takes in account all the merged pull request to master between the two given references, then it formats it in a nice consumable way.\n\nTo be effective, this script requires that you follow simple conventions:\n\n1. Your pull request titles must be written as changelog entries\n2. (Optional) Your project has git tags for each version you release (example: `0.3.0`)\n3. (Optional) Your pull request titles begin with some sort of tag (`Feature`, `Improvement`, `Fix`, `Internal`)\n\nThen a sample pull request title would be:\n\n\u003e Feature: shake the phone to send feedback email\n\nThis project itself is using this PR convention and the changelog generated with it can be found in https://github.com/schibsted/pr_changelog/releases\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'pr_changelog'\n```\n\nAnd then execute:\n\n```shell\n$ bundle\n```\n\nOr install it yourself as:\n\n```shell\n$ gem install pr_changelog\n```\n\n## Usage\n\nTo get the changes between to git tags `0.3.0` and `0.5.0`, execute:\n\n```\n$ pr_changelog 0.3.0 0.5.0\n```\n\nWill produce something like:\n\n```markdown\n## Changes from 0.3.0 to 0.5.0\n\n- #64: Improvement: visual refinements for canvas 2.0\n- #65: Internal: add formatting rules for xml files\n- #63: Feature: add Footer story\n- #57: Improvement: memory performance tweaks\n- #61: Feature: shake the phone to send feedback email\n- #62: Improvement: visual polishing for top stories\n- #60: Internal: setup hockeyapp for crash reporting\n```\n\nor\n\n```\n$ pr_changelog --format pretty 0.3.0 0.5.0\n```\n\nWill produce:\n\n```markdown\n## Changes since 0.3.0 to 0.5.0\n\n[New features]\n  - #61: ⭐️ Shake the phone to send feedback email\n\n[Improvements]\n  - #64: 💎 Visual refinements for canvas 2.0\n  - #57: 💎 Memory performance tweaks\n  - #62: 💎 Visual polishing for top stories\n\n[Internal]\n  - #65: 👨‍💻 Add formatting rules for xml files\n  - #60: 👨‍💻 Setup hockeyapp for crash reporting\n```\n\nIt's also possible to not pass any git references if you have sorted git tags. For example, if currently in your project you have the following tags:\n\n```\n$ git tag -l\n0.1.0\n0.1.1\n0.2.0\n0.2.1\n0.2.2\n```\n\nThen you can get the changes from the last release to `'master'` with:\n\n```\n$ pr_changelog\n\n## Changes since 0.2.2 to master\n\n...\n```\n\nIf you want to get the changes for the last release (between `0.2.1` and `0.2.2`) you can execute:\n\n```\n$ pr_changelog --last-release\n\n## Changes since 0.2.1 to 0.2.2\n\n...\n```\n\n\n\n\n## Configuration\n\nChange the emojis or add your own in a `.pr_changelog.json` file:\n\n```json\n{\n  \"tags\": [\n    {\n      \"prefix\": \"feature\",\n      \"emoji\": \"⭐️\",\n      \"title\": \"New features\"\n    },\n    {\n      \"prefix\": \"improvement\",\n      \"emoji\": \"💎\",\n      \"title\": \"Improvements\"\n    },\n    {\n      \"prefix\": \"unclassified\",\n      \"emoji\": \"❓\",\n      \"title\": \"Unclassified\"\n    }\n  ]\n}\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/schibsted/pr_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the `pr_changelog` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/schibsted/pr_changelog/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschibsted%2Fpr_changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschibsted%2Fpr_changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschibsted%2Fpr_changelog/lists"}