{"id":15823255,"url":"https://github.com/zapier/release-notes","last_synced_at":"2025-07-15T16:42:36.376Z","repository":{"id":57352789,"uuid":"133006960","full_name":"zapier/release-notes","owner":"zapier","description":"an npm module for pulling merged PRs and generating release notes from them","archived":false,"fork":false,"pushed_at":"2020-05-05T18:19:38.000Z","size":562,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":128,"default_branch":"master","last_synced_at":"2025-05-08T07:45:45.022Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/zapier.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":"2018-05-11T07:43:12.000Z","updated_at":"2021-10-23T19:45:02.000Z","dependencies_parsed_at":"2022-09-16T08:11:17.255Z","dependency_job_id":null,"html_url":"https://github.com/zapier/release-notes","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Frelease-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Frelease-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Frelease-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Frelease-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zapier","download_url":"https://codeload.github.com/zapier/release-notes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253025335,"owners_count":21842409,"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":[],"created_at":"2024-10-05T08:07:11.332Z","updated_at":"2025-05-08T07:45:50.589Z","avatar_url":"https://github.com/zapier.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# release-notes\n\n[![npm](https://img.shields.io/npm/v/release-notes.svg)](https://www.npmjs.com/package/release-notes)\n\nGenerate markdown from all of the PRs that have been closed since your last release!\n\nOriginally used to generate notes for [zapier-platform-cli](https://github.com/zapier/zapier-platform-cli) and its related repos.\n\n## Installation\n\n```bash\nnpm i -g release-notes\n```\n\n## Usage\n\nIn its simplest form, invoking this pulls the names of all of the closed PRs since the last time the given repo had a release. If passed multiple repos, it'll use the most recent release of the first as the date to filter against.\n\nFor more info, run:\n\n```bash\nrelease-notes -h\n```\n\n### Limitations\n\nCurrently, this is only set up to pull from Github. It can be expanded to use other providers if there's interest though!\n\n### Private Repos\n\nIf you need to access private repos, use either the `-t` flag or set your `GITHUB_API_TOKEN` before invoking the CLI.\n\n## API\n\nIn addition to a CLI, this package exports two functions for use javascript:\n\n### releaseNotes\n\nThe main method, this does calls to the github API and returns an object with a list of closed PRs grouped by repo name.\n\n### formatMarkdown\n\nTakes the above object of PRs and returns a nicely formatted markdown file. This is separate so if you want to build/parse the output yourself, it's easy to do.\n\nIt accepts an object with the following keys as the second parameter (all of which are optional):\n\n| Key       | Type       | Description                                                                       |\n| --------- | ---------- | --------------------------------------------------------------------------------- |\n| `keepOrg` | `boolean`  | if true, list the repo as `\u003cORG\u003e/\u003cREPO\u003e` instead of `\u003cREPO\u003e`. Defaults to `false` |\n| `order`   | `string[]` | print the repos in this order (which can be different than the supplied order)    |\n| `version` | `string`   | pre-fills the version number. Prints `MAJOR.MINOR.PATCH` if missing               |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzapier%2Frelease-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzapier%2Frelease-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzapier%2Frelease-notes/lists"}