{"id":20393045,"url":"https://github.com/aichbauer/node-semantic-git-release-cli","last_synced_at":"2025-04-12T11:54:44.384Z","repository":{"id":20957912,"uuid":"91383915","full_name":"aichbauer/node-semantic-git-release-cli","owner":"aichbauer","description":"A CLI for semantic releases. Writes a changelog and tags the new version.","archived":false,"fork":false,"pushed_at":"2023-01-04T07:40:55.000Z","size":5449,"stargazers_count":6,"open_issues_count":17,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-26T06:43:17.182Z","etag":null,"topics":["changelog","cli","git","nodejs","release","semantic","semantic-releases","semver","tag","version"],"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/aichbauer.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":"2017-05-15T20:54:01.000Z","updated_at":"2023-11-08T20:10:35.000Z","dependencies_parsed_at":"2023-01-12T03:31:03.510Z","dependency_job_id":null,"html_url":"https://github.com/aichbauer/node-semantic-git-release-cli","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aichbauer%2Fnode-semantic-git-release-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aichbauer%2Fnode-semantic-git-release-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aichbauer%2Fnode-semantic-git-release-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aichbauer%2Fnode-semantic-git-release-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aichbauer","download_url":"https://codeload.github.com/aichbauer/node-semantic-git-release-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565051,"owners_count":21125415,"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","cli","git","nodejs","release","semantic","semantic-releases","semver","tag","version"],"created_at":"2024-11-15T03:47:08.390Z","updated_at":"2025-04-12T11:54:44.363Z","avatar_url":"https://github.com/aichbauer.png","language":"JavaScript","readme":"# semantic-git-release-cli\n\n[![Build Status](https://travis-ci.org/aichbauer/node-semantic-git-release-cli.svg?branch=master)](https://travis-ci.org/aichbauer/node-semantic-git-release-cli)\n[![Build status](https://ci.appveyor.com/api/projects/status/7kedayu8diw41day?svg=true)](https://ci.appveyor.com/project/rudolfsonjunior/node-semantic-git-release-cli)\n[![Coverage Status](https://coveralls.io/repos/github/aichbauer/node-semantic-git-release-cli/badge.svg?branch=master)](https://coveralls.io/github/aichbauer/node-semantic-git-release-cli?branch=master)\n\n\u003e A CLI for semantic releases. Writes a changelog and tags the new version.\n\n\u003cimg src=\"https://raw.githubusercontent.com/aichbauer/node-semantic-git-release-cli/master/media/screenshot.gif\"\u003e\n\n## Table of contents\n\n- [Why](#why)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Commands](#commands)\n  - [sgr](#sgr)\n  - [sgr recover](#sgr-recover)\n  - [sgr version](#sgr-version)\n- [Options](#options)\n  - [sgr recover --backup](#sgr-recover---backup)\n  - [sgr --help](#sgr---help)\n  - [sgr --version](#sgr---version)\n\n## Why?\n\nMany projects need versioning. It is always the same: testing, writing the changelog, updating the version, tagging the commit, and finally releasing the new version.\n\n`sgr` will take care of all of them, so you can focus on the more important stuff: **code**\n\n## Installation\n\n```sh\n$ npm i -g semantic-git-release-cli\n```\n\nor\n\n```sh\n$ yarn add global semantic-git-release-cli\n```\n\n## Usage\n\nForget the times when you had to manually write changelogs, update versions, tag commits. Now just type:\n\n```sh\n$ sgr\n```\n\nor if you already have an alias for sgr, use following instead:\n\n```sh\n$ semantic-git-release\n```\n\n## Commands\n\n`semantic-git-release-cli` was build to be as simple as possible, so there are just a few commands you need to know.\n\n- [sgr](#sgr)\n- [sgr recover](#sgr-recover)\n- [sgr version](#sgr-version)\n\n## Options\n\n`semantic-git-release-cli` was build to be as simple as possible, so there are just a few options you need to know.\n\n- [sgr recover --backup](#sgr-recover---backup)\n- [sgr --help](#sgr---help)\n- [sgr --version](#sgr---version)\n\n### sgr\n\nWith `sgr` you can release a new version of your project.\n\n#### Tasks\n\nSo there are a few tasks `semantic-git-release-cli` will do for you:\n\n- removes and reinstalls `node_modules` (prefers `yarn` by default)\n- runs tests by calling `npm test`\n- updates the `version` in `package.json`\n- creates or updates the `CHANGELOG.md`\n- commits and tags the new `version`\n\n```sh\n# release a new version\n$ sgr\n```\n\n### sgr recover\n\nWith `sgr recover [backup]` you can recover your complete CHANGELOG.md if you just started to use `semantic-git-release-cli` but already released (and tagged) versions.\n\n```sh\n# generates the complete CHANGELOG.md\n$ sgr recover\n# generates the complete CHANGELOG.md, and creates a backup of the old one\n$ sgr recover --backup\n```\n\n### sgr version\n\nWith `sgr version` you can display the current version of `semantic-git-release-cli`.\n\n```sh\n# current version\n$ sgr version\n```\n\n### sgr recover --backup\n\nWith `sgr recover --backup` you can recover your complete CHANGELOG.md, and recover the old CHANGELOG.md to `.sgr_backup`.\n\n```sh\n# generates the complete CHANGELOG.md and saves the old CHANGELOG.md to `.sgr_backup`\n$ sgr recover --backup\n```\n\n### sgr --help\n\nWith `sgr --help` you can display usage of `semantic-git-release-cli`.\n\n```sh\n# usage of cli\n$ sgr --help\n```\n\n### sgr --version\n\nWith `sgr --version` you can display the current version of `semantic-git-release-cli`.\n\n```sh\n# current version\n$ sgr --version\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faichbauer%2Fnode-semantic-git-release-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faichbauer%2Fnode-semantic-git-release-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faichbauer%2Fnode-semantic-git-release-cli/lists"}