README.ja.md

Release GitHub Actions CLI

Read this in other languages: English, 日本語.

Release GitHub Actions の CLIツール

Table of Contents

Details

• スクリーンショット
• 使用方法
  • package で使用
  • グローバルで使用
• Args
  • 必須
  • オプション
• 設定
  • OWNER
  • REPO
  • INPUTS
• Author

スクリーンショット

使用方法

package で使用

1. インストール

   yarn add --dev @technote-space/release-github-actions-cli

2. コマンド実行

   yarn release-ga --token <token> -t <tag>

   ヘルプ表示

   yarn release-ga -h

グローバルで使用

1. インストール

   yarn global add @technote-space/release-github-actions-cli

2. コマンド実行

   release-ga --token <token> -p <package dir> -t <tag>

   ヘルプ表示

   release-ga -h

Args

必須

token

personal access token

例：

--token 1234567890

token が書かれた .env ファイルを用意している場合は不要です。
例：

token=1234567890

tag

detail

例：

--tag v1.2.3

-t v1.2.3

test オプションを設定している場合は不要です。

オプション

branch

ビルドに使用するブランチ名
このオプションが指定されていない場合、現在のソースコードが使用されます。

例：

--branch release/v1.2.3

-b release/v1.2.3

dry run

プッシュしないかどうか

例：

--dry-run

-n

package file directory

package.json ファイルのあるディレクトリ

例：

--package /tmp/test-repo

-p /tmp/test-repo

test

テストモード

タグ名は最新のタグから決まります。
テスト用タグプリフィックスに test/ が設定されます。

設定

Release GitHub Actions CLI は .releasegarc, .releasegarc.json, .releasegarc.js, .releasega.config.js または package.json の releasega プロパティで設定できます。

例： .releasegarc

{
  "owner": "test-owner",
  "repo": "test-repo",
  "inputs": {
    "test-tag-prefix": "test/",
    "fetch-depth": "5"
  }
}

例： package.json

{
  "name": "test",
  "version": "1.0.0",
  "repository": {
  },
  "dependencies": {
  },
  "releasega": {
    "owner": "test-owner",
    "repo": "test-repo",
    "inputs": {
      "test-tag-prefix": "test/",
      "fetch-depth": "5"
    }
  }
}

OWNER

Owner を指定するために使用します。
default: package.json 内のURLから検出します

REPO

Repo を指定するために使用します。
default: package.json 内のURLから検出します。

INPUTS

アクションの inputs を設定します。
action.yml

例：

{
  "inputs": {
    "commit message": "test message",
    "commit-name": "test name",
    "COMMIT_EMAIL": "test@example.com"
  }
}

Author

GitHub (Technote)
Blog