{"id":20247593,"url":"https://github.com/design4pro/release-me","last_synced_at":"2026-05-10T11:41:01.311Z","repository":{"id":57352785,"uuid":"93031255","full_name":"design4pro/release-me","owner":"design4pro","description":"Replacement for `npm version` with automatic CHANGELOG generation","archived":false,"fork":false,"pushed_at":"2018-09-12T07:11:07.000Z","size":263,"stargazers_count":0,"open_issues_count":11,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-14T08:25:27.764Z","etag":null,"topics":["changelog","conventional-changelog","release"],"latest_commit_sha":null,"homepage":"","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/design4pro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-01T07:51:47.000Z","updated_at":"2017-06-06T21:27:59.000Z","dependencies_parsed_at":"2022-09-05T13:11:10.492Z","dependency_job_id":null,"html_url":"https://github.com/design4pro/release-me","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Frelease-me","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Frelease-me/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Frelease-me/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Frelease-me/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/design4pro","download_url":"https://codeload.github.com/design4pro/release-me/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241693534,"owners_count":20004442,"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","conventional-changelog","release"],"created_at":"2024-11-14T09:38:05.689Z","updated_at":"2026-05-10T11:41:01.265Z","avatar_url":"https://github.com/design4pro.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release Me\n\n[![travis build](https://img.shields.io/travis/design4pro/release-me.svg)](https://travis-ci.org/design4pro/release-me) [![CircleCI](https://circleci.com/gh/design4pro/release-me.svg?\u0026style=shield\u0026circle-token=dcae2e86230ae035ea4ae977ae55f58f20a00ac9)](https://circleci.com/gh/design4pro/release-me) [![codecov coverage](https://img.shields.io/codecov/c/gh/design4pro/release-me.svg)](https://codecov.io/gh/design4pro/release-me) [![npm](https://img.shields.io/npm/v/release-me.svg)](https://www.npmjs.com/package/release-me) [![npm](https://img.shields.io/npm/dt/release-me.svg)](https://www.npmjs.com/package/release-me) [![Greenkeeper badge](https://badges.greenkeeper.io/design4pro/release-me.svg)](https://greenkeeper.io/)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdesign4pro%2Frelease-me.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdesign4pro%2Frelease-me?ref=badge_shield)\n\n\u003e stop using npm version, use release-me\n\nAutomatic versioning and CHANGELOG generation.\n\nHow it works:\n\n1. when you're ready to release to npm:\n2. `git checkout master; git pull origin master`\n3. `run release-me`\n4. `git push --follow-tags origin master; npm publish`\n\n`release-me` does the following:\n\n1. bumps the version in package.json/bower.json (based on your commit history)\n2. uses conventional-changelog (with [conventional-changelog-release-me](https://github.com/design4pro/conventional-changelog-release-me) preset) to update CHANGELOG.md\n3. commits package.json (et al.) and CHANGELOG.md\n4. tags a new release\n\n###Installation\n\n**As npm run script**\n\nInstall and add to devDependencies:\n\n```bash\nnpm i --save-dev release-me\n```\n\nAdd an npm run script to your package.json:\n\n```json\n{\n  \"scripts\": {\n    \"release\": \"release-me\"\n  }\n}\n```\n\nNow you can use npm run release in place of npm version.\n\nThis has the benefit of making your repo/package more portable, so that other developers can cut releases without having to globally install `release-me` their machine.\n\n**As global bin**\n\nInstall globally (add to your PATH):\n\n```bash\nnpm i -g release-me\n```\n\nNow you can use `release-me` in place of npm version.\n\nThis has the benefit of allowing you to use `release-me` on any repo/package without adding a dev dependency to each one.\n\n\n## License\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdesign4pro%2Frelease-me.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdesign4pro%2Frelease-me?ref=badge_large)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesign4pro%2Frelease-me","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdesign4pro%2Frelease-me","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesign4pro%2Frelease-me/lists"}