ワークフローを Organization と共有する

ワークフローテンプレート、シークレット、およびセルフホストランナーを共有することで、Organization 機能を使用して Team とコラボレーションする方法を学びます。

ここには以下の内容があります:

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

GitHub Actions の支払いを管理する GitHubは、macOSランナーのホストにMacStadiumを使用しています。

ワークフローやその他の GitHub Actions 機能を Team と共有する必要がある場合は、GitHub Organization 内でのコラボレーションを検討します。 Organization を使用すると、シークレット、アーティファクト、およびセルフホストランナーを一元的に保存および管理できます。 .github リポジトリにワークフローテンプレートを作成して、Organization 内の他のユーザと共有することもできます。

ワークフローテンプレートの作成

ワークフローテンプレートは、組織の .github リポジトリへの書き込みアクセス権を持つユーザーによって作成できます。その後、ワークフローを作成する権限を持つ組織メンバーがテンプレートを使用できます。ワークフローテンプレートを使用すると、組織のパブリックリポジトリに新しいワークフローを作成できます。テンプレートを使用してプライベートリポジトリにワークフローを作成するには、組織がエンタープライズプランまたはGitHub Oneプランの一部である必要があります。

この手順では、ワークフローテンプレートとメタデータファイルを作成する方法を示します。メタデータファイルには、ユーザーが新しいワークフローを作成するときにテンプレートがどのように表示されるかについて説明します。

存在しない場合は、組織内で .github `という名前の新しいパブリックリポジトリを作成します。

ワークフローテンプレートという名前のディレクトリ作成`。

ワークフローテンプレートディレクトリ内に新しいワークフローファイルを作成します。リポジトリのデフォルトブランチを参照する必要がある場合は、 $default-branch プレースホルダを使用できます。テンプレートを使用してワークフローを作成すると、プレースホルダはリポジトリのデフォルトブランチの名前に自動的に置き換えられます。
たとえば、octo-organization-ci.yml `名前のこのファイルは、基本的なワークフローを示しています。
```
   name: Octo Organization CI

   :
     プッシュ:
       ブランチ: [ $default-ブランチ ]
     pull_request:
       ブランチ: [ $default-ブランチ]

   ジョブ:
     ビルド:
       実行: ubuntu-最新

       ステップ:
       - 使用: アクション/checkout@v2

       - 名前: 1 行スクリプトを実行
         実行します: Octo Organization から hello をエコーします
`
```

ワークフローテンプレートディレクトリ内にメタデータファイルを作成します。メタデータファイルは、ワークフローファイルと同じ名前である必要がありますが、 .yml 拡張子の代わりに、 .properties.jsonを付ける必要があります。たとえば、octo-organization-ci.properties.json 名前のこのファイルには、octo-organization-ci.yml`名前のワークフローファイルのメタデータが含まれています。
```
   { "名前"
       " " " " " " " " " "説明"
       " "説明" " " "" "アイコン"
       " "example-icon"
       "" "  "" "
       " " [
           "go"  ]
       "filePatterns" [
           "package.json$" 」
   
       
           、
           "^Dockerfile"
`
```
- アイコン名前 - 必須。テンプレートリスト内のワークフローのエントリのアイコンを定義します。 iconName は、同じ名前の SVG アイコンである必要があり、ワークフローテンプレートディレクトリに格納する必要があります。たとえば、example-icon.svg 名前の SVG ファイルは、 <code>例アイコンとして参照されます。
- カテゴリ - オプション。ワークフローの言語カテゴリを定義します。ユーザーが使用可能なテンプレートを表示すると、同じ言語に一致するテンプレートの機能が顕著になります。使用可能な言語カテゴリについては、「https://github.com/github/linguist/blob/master/lib/linguist/languages.yml」を参照してください。
- ファイルパターン - オプション。定義された正規表現に一致するファイルがユーザーのリポジトリのルートディレクトリにある場合に、テンプレートを使用できるようにします。