【GitHub Actions】実行時にパラメータ項目を設定する

設定を編集できる場所#

それでは、choice型以外のものも見ていきましょう。 その項目は、GitHub Actionsを作る時に記述するworkflowファイルで設定できます。 まずは、リポジトリ直下の.github/workflowのディレクトリに移動します。

そして、このディレクトリで.yml形式のファイルを作成していきます。 その.ymlファイルの中で、on.workflow_dispatch.inputsフィールド上で、Actions実行に設定する要素を編集できます。 主に使うものはこんなところでしょうか。

string型 - 文字列を入力できる#

stringは、任意の文字を入力することが出来ます。 入力中、特に制限を掛けられるわけではないみたいなので、ワークフロー実行時に例外処理を組み込んでいくことになるかと思います。

choice型 - 選択肢を選べる#

choiceは、HTMLのselectタグのように選択肢を設定して、編集することが出来ます。 例えば、こんな風にワークフローファイルで設定すると・・・、

1
name: Get Snippet
2
on:
3
  workflow_dispatch:
4
    inputs:
5
      logLevel:
6
        description: 'Log level'
7
        required: true
8
        type: choice
9
        default: 'info'
10
        options:
11
        - info
12
        - warning
13
        - debug
14
      year:
15
        description: Year
16
        required: true
17
        type: string
18
      month:
19
        description: Month
20
        required: true
21
        type: choice
22
        default: '01'
23
        options:
24
        - '01'
25
        - '02'
26
        - '03'
27
        - '04'
28
        - '05'
29
        - '06'
30
        - '07'
31
        - '08'
32
        - '09'
33
        - '10'
34
        - '11'
35
        - '12'

monthのフィールドはこんな風になります。

boolean型 - チェックボックス#

このデータ型は、チェックボックスとしてチェックあり/なしを設定できる項目です。

environment型 - 環境の一覧から選択する#

この型はまた一味違います。 まず、リポジトリのSettingsタブから遷移できる、Environmentsの画面でSecretやらを設定できるようです。（この機能は、Organizationプランでないと利用できないっぽい？） そこで設定した環境（StagingやらProductionやらあるかと思います）が選択肢として選択できるようになるようです。以下の記事を見て知りました。

Zenn

GitHub Actionsで手動でワークフローを実行する際のenvironmentパラメータを使ってみる

zenn.dev

その他#

色々と入力型を決めて編集できますが、それらの項目を必須か任意にするかどうかも編集できます。 先程お見せした画像にて、赤い※が付いているかいないかで見分けられます。

この他にも、number型があるようですが、 2023/2/8現在、文字列と比べて特に入力制限があるわけではないようです・・・。なので、Actions実行前にstring型で入力して、Actions内で数値にキャストできるかどうかで例外分岐するのが吉でしょうか。