grmc

git release management command-line tool

Functions

• Create Pull Request
• Merge Pull Request
• Create tag
• Create Release note
  • write release note by pr list

Installation

yarn add -D grmc
npm install --save-dev grmc

Get Git Access Token

• https://github.com/settings/tokens

git token needs the read and write auth

Create the .config/release.yml

baseUrl: https://api.github.com
token:

repo: { owner: repo_owner, name: repo_name }

branch: { master: master, develop: develop, release: release, hotfix: hotfix }

tag: { prefix: v }

release:
  {
    title:
      {
        major: major/%tag_name%,
        minor: minor/%tag_name%,
        patch: patch/%tag_name%,
      },
  }

Usage

Run Cli

$ grmc rel major -c .config/release-local.yml
🚀 Start create pr & merge process
? Do you want to create pr? (Y/n) Y
? Choose the target branch release/1.0.0
? Create PR to 'main' branch Yes
? Merge PR to 'main' branch Yes
? Create PR to 'feature/cli' branch No


======================================
Pull Request & Merge Configuration
======================================
Release Branch:      release/1.0.0

Target Branch List
  - main:            PR(Y), Merge(Y)
  - feature/cli:     PR(N), Merge(N)


? Do you want to continue? (Y/n)

Run Only Create Release Note

$ grmc rel major -c .config/release-local.yml
🚀 Start create pr & merge process
? Do you want to create pr? No

🚀 Start create tag and release note from main
⠧ Loading generate release content...

✔ generated the release note content
------------------------------------
#### Changelogs
* ci: add build script (#18) bae63f4

#### Milestone
https://github.com/gloriaJun/github-release-cli/milestone/1
------------------------------------
? Do you want to create the tag (v0.2.0 -> v0.3.0) ? Yes
✔ Success release v0.3.0 from main 🎉🎉🎉
🔗  https://github.com/gloriaJun/github-release-cli/releases/tag/v0.3.0
✨  Done in 73.98s.