{"id":13510111,"url":"https://github.com/vercel/release","last_synced_at":"2025-05-14T00:11:29.762Z","repository":{"id":39599462,"uuid":"77129283","full_name":"vercel/release","owner":"vercel","description":"Generate changelogs with a single command","archived":false,"fork":false,"pushed_at":"2024-06-08T20:31:42.000Z","size":749,"stargazers_count":3579,"open_issues_count":46,"forks_count":114,"subscribers_count":82,"default_branch":"master","last_synced_at":"2025-05-07T18:51:44.966Z","etag":null,"topics":["github","npm","releases","vercel"],"latest_commit_sha":null,"homepage":"https://npmjs.com/release","language":"JavaScript","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/vercel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-22T08:58:33.000Z","updated_at":"2025-04-30T08:54:43.000Z","dependencies_parsed_at":"2024-01-03T04:13:57.605Z","dependency_job_id":"2f2aafca-e04c-4369-803d-425a01805792","html_url":"https://github.com/vercel/release","commit_stats":{"total_commits":403,"total_committers":23,"mean_commits":17.52173913043478,"dds":0.1017369727047146,"last_synced_commit":"30ad67d003830531a27cd5cc45068a6b415a3ae7"},"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2Frelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2Frelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2Frelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2Frelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vercel","download_url":"https://codeload.github.com/vercel/release/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253214592,"owners_count":21872503,"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":["github","npm","releases","vercel"],"created_at":"2024-08-01T02:01:24.525Z","updated_at":"2025-05-14T00:11:24.754Z","avatar_url":"https://github.com/vercel.png","language":"JavaScript","readme":"\u003ca aria-label=\"Vercel logo\" href=\"https://vercel.com\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge\u0026logo=vercel\u0026labelColor=000000\u0026logoWidth=20\"\u003e\n\u003c/a\u003e\n\n# Release\n\nRelease is a command line tool to automatically generate a new [GitHub Release](https://help.github.com/articles/creating-releases/) and populates it with the changes (commits) made since the last release.\n\n## Usage\n\nFirstly, install the package from [npm](https://npmjs.com/release):\n\n```bash\nnpm install -g release\n```\n\nAlternatively, you can use [Yarn](https://yarnpkg.com/en/) to install it:\n\n```bash\nyarn global add release\n```\n\nOnce that's done, you can run this command inside your project's directory:\n\n```bash\nrelease \u003ctype\u003e\n```\n\nA `\u003ctype\u003e` argument can be passed. If you leave it out, a [GitHub Release](https://help.github.com/articles/creating-releases/) will be created from the most recent commit and tag.\n\nAccording to the [SemVer](https://semver.org) spec, the argument can have one of these values:\n\n-   `major`: Incompatible API changes were introduced\n-   `minor`: Functionality was added in a backwards-compatible manner\n-   `patch`: Backwards-compatible bug fixes were applied\n\nIn addition to those values, we also support creating pre-releases like `3.0.0-canary.1`:\n\n```bash\nrelease pre\n```\n\nYou can also apply a custom suffix in place of \"canary\" like this:\n\n```bash\nrelease pre \u003csuffix\u003e\n```\n\nAssuming that you provide \"beta\" as the `\u003csuffix\u003e` your release will then be `3.0.0-beta.1` – and so on...\n\n## Options\n\nThe following command will show you a list of all available options:\n\n```bash\nrelease help\n```\n\n## Pre-Defining Types\n\nIf you want to automate `release` even further, specify the change type of your commits by adding it to the **title** or **description** within parenthesis:\n\n\u003e Error logging works now (patch)\n\nAssuming that you've defined it for a certain commit, `release` won't ask you to set a type for it manually. This will make the process of creating a release even faster.\n\nTo pre-define that a commit should be excluded from the list, you can use this keyword:\n\n\u003e This is a commit message (ignore)\n\n## Custom Hook\n\nSometimes you might want to filter the information that gets inserted into new releases by adding an intro text, replacing certain data or just changing the order of the changes.\n\nWith a custom hook, the examples above (and many more) are very easy to accomplish:\n\nBy default, release will look for a file named `release.js` in the root directory of your project. This file should export a function with two parameters and always return a `String` (the final release):\n\n```js\nmodule.exports = async (markdown, metaData) =\u003e {\n\t// Use the available data to create a custom release\n\treturn markdown;\n};\n```\n\nIn the example above, `markdown` contains the release as a `String` (if you just want to replace something). In addition, `metaData` contains these properties:\n\n| Property Name    | Content                                               |\n| ---------------- | ----------------------------------------------------- |\n| `changeTypes`    | The types of changes and their descriptions           |\n| `commits`        | A list of commits since the latest release            |\n| `groupedCommits` | Similar to `commits`, but grouped by the change types |\n| `authors`        | The GitHub usernames of the release collaborators     |\n\n**Hint:** You can specify a custom location for the hook file using the `--hook` or `-H` flag, which takes in a path relative to the current working directory.\n\n## Why?\n\nAs we at [Vercel](https://github.com/vercel) moved all of our GitHub repositories from keeping a `HISTORY.md` file to using [GitHub Releases](https://help.github.com/articles/creating-releases/), we needed a way to automatically generate these releases from our own devices, rather than always having to open a page in the browser and manually add the notes for each change.\n\n## Contributing\n\nYou can find the authentication flow [here](https://github.com/vercel/release-auth).\n\n1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device\n2. Uninstall the package if it's already installed: `npm uninstall -g release`\n3. Link the package to the global module directory: `npm link`\n4. You can now use `release` on the command line!\n\nAs always, you can use `npm test` to run the tests and see if your changes have broken anything.\n\n## Credits\n\nThanks a lot to [Daniel Chatfield](https://github.com/danielchatfield) for donating the \"release\" name on [npm](https://www.npmjs.com) and [my lovely team](https://vercel.com/about) for telling me about their needs and how I can make this package as efficient as possible.\n\n## Author\n\nLeo Lamprecht ([@leo](https://x.com/leo))\n","funding_links":[],"categories":["Development","JavaScript","vercel"],"sub_categories":["Release"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvercel%2Frelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvercel%2Frelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvercel%2Frelease/lists"}