{"id":15293481,"url":"https://github.com/bahmutov/simple-changelog","last_synced_at":"2025-04-13T14:07:29.304Z","repository":{"id":57359874,"uuid":"97670245","full_name":"bahmutov/simple-changelog","owner":"bahmutov","description":"Simple GitHub release changelog from public semantic commits","archived":false,"fork":false,"pushed_at":"2017-10-25T04:11:42.000Z","size":20,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T05:04:41.183Z","etag":null,"topics":["changelog","commit","github","release","semantic-release"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bahmutov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-19T03:47:55.000Z","updated_at":"2017-10-30T04:28:18.000Z","dependencies_parsed_at":"2022-09-06T22:22:26.923Z","dependency_job_id":null,"html_url":"https://github.com/bahmutov/simple-changelog","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fsimple-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fsimple-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fsimple-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Fsimple-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bahmutov","download_url":"https://codeload.github.com/bahmutov/simple-changelog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248606642,"owners_count":21132393,"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","commit","github","release","semantic-release"],"created_at":"2024-09-30T16:48:55.414Z","updated_at":"2025-04-13T14:07:29.284Z","avatar_url":"https://github.com/bahmutov.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# simple-changelog\n\n\u003e Simple GitHub release changelog from public semantic commits\n\n[![NPM][npm-icon] ][npm-url]\n\n[![Build status][ci-image] ][ci-url]\n[![semantic-release][semantic-image] ][semantic-url]\n[![js-standard-style][standard-image]][standard-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n## Install\n\nRequires [Node](https://nodejs.org/en/) version 6 or above.\n\n```sh\nnpm install --save simple-changelog\n```\n\n## Examples\n\nSee these example release docs\n\n* [github-post-release/releases](https://github.com/bahmutov/github-post-release/releases)\n\n## Use\n\nTo get good release changelog from semantic commits\n\n```js\nconst changelog = require('simple-changelog')\nchangelog('1.2.3')\n  .then(console.log)\n```\n\nPrints Markdown like with grouped breaking changes, new features and bug\nfixes.\n\n```\n# 1.2.3 (2017-07-19)\n## New features\n### docs\n* documentation feature 1 (sha)\n...\n```\n\n## Non-semantic mode\n\nSometimes we want to publish release notes, even if we have not followed\nsemantic convention. For this, pass a number of commits to allow including\nin the log. For example\n\n```js\nconst changelog = require('simple-changelog')\nchangelog('1.2.3', 3)\n  .then(console.log)\n```\n\nIf there are semantic commits - only semantic public commits will be used.\nIf there are fewer than 3 commits (of any type), they will be in the changelog.\nOtherwise the log will have only the version and the date.\n\n## Debugging\n\nRun with `DEBUG=simple-changelog ...` environment variable\n\n### Small print\n\nAuthor: Gleb Bahmutov \u0026lt;gleb.bahmutov@gmail.com\u0026gt; \u0026copy; 2017\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](https://glebbahmutov.com)\n* [blog](https://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/simple-changelog/issues) on Github\n\n## MIT License\n\nCopyright (c) 2017 Gleb Bahmutov \u0026lt;gleb.bahmutov@gmail.com\u0026gt;\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\n[npm-icon]: https://nodei.co/npm/simple-changelog.svg?downloads=true\n[npm-url]: https://npmjs.org/package/simple-changelog\n[ci-image]: https://travis-ci.org/bahmutov/simple-changelog.svg?branch=master\n[ci-url]: https://travis-ci.org/bahmutov/simple-changelog\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n[standard-url]: http://standardjs.com/\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Fsimple-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbahmutov%2Fsimple-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Fsimple-changelog/lists"}