Actionsの開発ツールGitHubホストランナーの仮想環境GitHubホストランナーにインストールされるソフトウェアドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。Actionsのメタデータ構文リポジトリでタスクを実行するアクションを作成できます。アクションには、YAML構文を使うメタデータファイルが必要です。Oneで利用できます。詳しい情報については「GitHubの製品」を参照してください。ActionsのYAML構文についてDocker及びJavaScriptアクションにはメタデータファイルが必要です。このメタデータのファイル名はaction.ymlもしくはaction.yamlでなければなりません。メタデータファイル中のデータは、アクションの入力、出力、メインエントリポイントを定義します。アクションのメタデータファイルはYAML構文を使います。(5分で学ぶYAML)」をお読みください。name必須アクションの名前。GitHubはnameをActionsタブに表示して、それぞれのジョブのアクションを見て区別しやすくします。アクションの作者の名前。アクションの短い説明。inputsパラメーターを使うと、アクションが実行時に使うデータを指定できます。GitHubは、inputsパラメータを環境変数として保存します。大文字が使われているInputsのidは、実行時に小文字に変換されます。inputsのidには小文字を使うことをおすすめします。2つの入力を設定しています。入力のnumOctocatsは必須ではなく、デフォルトの値は'1'になっています。入力のoctocatEyeColorは必須であり、デフォルト値を持ちません。このアクションを使うワークフローのファイルは、withキーワードを使ってoctocatEyeColorの入力値を設定しなければなりません。Actionsのためのワークフローの構文」を参照してください。trueワークフローファイル内で、あるいはデフォルトの入力値を使ってアクションに入力を指定すると、GitHubはその入力に対応してINPUT_<VARIABLE_NAME>という名前の環境変数を生成します。生成される環境変数では、入力の名前を大文字にして、空白を_に変換します。ワークフローがnumOctocats及びoctocatEyeColorという入力を定義すると、アクションのコードはこれらの入力の値をINPUT_NUMOCTOCATS及びINPUT_OCTOCATEYECOLORという環境変数で読み取れます。文字列型の識別子で、入力と結びつけられます。<input_id>の値は、入力のメタデータのマップです。<input_id>は、inputsオブジェクト内でユニークな識別子でなければなりません。<input_id>は、文字あるいは_で始める必要があり、英数字、-、_しか使用できません。入力パラメーターの文字列での説明。この入力パラメーターがアクションに必須かどうかを示す論理値。パラメーターが必須の場合はtrueに設定してください。デフォルト値を示す文字列。デフォルト値は、入力パラメーターがワークフローファイルで指定されたなかった場合に使われます。アクションが設定するデータを宣言できる出力パラメータ。ワークフローで後に実行されるアクションは、先行して実行されたアクションが設定した出力データを利用できます。z)するアクションがあれば、そのアクションは他のアクションが入力として利用できる合計値(z)を出力できます。メタデータファイル中でアクション内の出力を宣言しなくても、出力を設定してワークフロー中で利用することはできます。Actionsの開発ツール」を参照してください。文字列型の識別子で、出力と結びつけられます。<output_id>の値は、出力のメタデータのマップです。<output_id>は、outputsオブジェクト内でユニークな識別子でなければなりません。<output_id>は、文字あるいは_で始める必要があり、英数字、-、_しか使用できません。出力パラメーターの文字列での説明。アクションが実行されたときに走るコマンド。mainで指定されたコードを実行するのに使われるアプリケーション。コンテナ環境に設定する環境変数のキー/値のマップを指定します。アクションコードを含むコードファイル。using構文を使って指定されたアプリケーションがこのファイルを実行します。コンテナがアクションを実行する際に使用するDockerイメージ。Hubあるいはリポジトリ内のローカルのDockerfileを指定できます。自分のリポジトリにローカルなDockerfileを参照するには、アクションのメタデータファイルに対する相対的なパスを使ってください。using構文を使って指定されたアプリケーションがこのファイルを実行します。Dockerfile中のDockerのENTRYPOINTをオーバーライドします。それが指定されていなかった場合に設定します。アクションがrunsキーワードを使わない場合、このentrypoint内のコマンドが実行されます。DockerのENTRYPOINT命令にはshell形式とexec形式があります。DockerのENTRYPOINTのドキュメンテーションでは、ENTRYPOINTの命令としてexec形式を使うことをすすめています。Dockerコンテナへの入力を定義する文字列の配列。入力には、ハードコードされた文字列を含めることができます。GitHubは、コンテナの起動時にargsをコンテナのENTRYPOINTに渡します。argsは、Dockerfile中のCMD命令の場所で使われます。Dockerfile中でCMDを使うなら、以下の優先順位順のガイドラインを利用してください。必須の引数をアクションのREADME中でドキュメント化し、CMD命令から除外してください。argsを指定せずにアクションを利用できるよう、デフォルトを使ってください。アクションが--helpフラグやそれに類するものを備えているなら、アクションを自己ドキュメント化するためのデフォルトとして利用してください。'green'colorバッジの背景カラー。white、yellow、blue、green、orange、red、purple、gray-darkのいずれか。icon利用するFeatherアイコンの名前。Inc.規約プライバシ。