Release GitHub Actions CLI


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

Release GitHub Actions の CLIツール

Table of Contents

Details

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

スクリーンショット

!Cli

使用方法

$3

1. インストール
``shell script
yarn add --dev @technote-space/release-github-actions-cli
`
1. コマンド実行
`shell script
yarn release-ga --token -t
`

ヘルプ表示

`shell script
yarn release-ga -h
`

$3


1. インストール
`shell script
yarn global add @technote-space/release-github-actions-cli
`
1. コマンド実行
`shell script
release-ga --token -p -t
`

ヘルプ表示

`shell script
release-ga -h
`

Args

$3

#### token
personal access token

例：
`
--token 1234567890
`

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

#### tag
detail

例：
`
--tag v1.2.3
`

`
-t v1.2.3
`

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

$3

#### 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
`json
{
"owner": "test-owner",
"repo": "test-repo",
"inputs": {
"test-tag-prefix": "test/",
"fetch-depth": "5"
}
}
`

例： package.json
`json
{
"name": "test",
"version": "1.0.0",
"repository": {
},
"dependencies": {
},
"releasega": {
"owner": "test-owner",
"repo": "test-repo",
"inputs": {
"test-tag-prefix": "test/",
"fetch-depth": "5"
}
}
}
`

$3


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

$3

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

$3

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

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

Author

GitHub (Technote)
Blog