Organization のスターターワークフローを作成する

注: GitHub ホステッドランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

概要

スターターワークフローを使用すると、ワークフローを作成するアクセス許可を持つ Organization 内のすべての人が、より迅速かつ簡単にワークフローを作成できます。新しいワークフローを作成する� �合は、スターターワークフローを選択すると、ワークフローを作成する作業の一部またはすべてを自動的に行うことができます。スターターワークフローは、カスタ� ワークフローの構築の出発点として利用することも、そのまま利用することもできます。これにより、時間を節約できる� けでなく、Organization 全体の一貫性とベストプラクティスが促進されます。

GitHub には、次の高レベルのカテゴリにすぐに使用できるスターターワークフローが用意されています。

デプロイ (CD) 。詳細については、「継続的デプロイについて」を参照してく� さい。
継続的インテグレーション (CI) 。詳細については、「継続的インテグレーションについて」を参照してく� さい。
オートメーション。 Automation スターターワークフローには、pull request のトリアージや、pull request で変更されたパスに基づくラベルの適用、リポジトリに初めて投稿する人へのあいさつなど、ワークフローを自動化するためのソリューションが用意されています。

スターターワークフローを作成する

Organization の .github リポジトリへの書き込みアクセス権を持つユーザーは、スターターワークフローを作成できます。その後、ワークフローを作成するアクセス許可を持つ Organization のメンバーはそれを使用できます。

この手� �では、スターターワークフローとメタデータファイルを作成する方法を示します。メタデータファイルには、ユーザーが新しいワークフローを作成するときに、スターターワークフローがどのように表示されるかが記述されています。

それがま� ない� �合は、Organization で .github という名前の新しいパブリックリポジトリを作成します。
workflow-templates という名前のディレクトリを作成します。
workflow-templates ディレクトリ内に新しいワークフローファイルを作成します。

リポジトリの既定のブランチを参照する必要がある� �合は、$default-branch プレースホルダーを使用できます。ワークフローが作成されるとき、プレースホルダーはリポジトリの既定のブランチの名前に自動的に置き換えられます。

たとえば、octo-organization-ci.yml という名前のこのファイルは、基本的なワークフローを示しています。
```
name: Octo Organization CI

on:
  push:
    branches: [ $default-branch ]
  pull_request:
    branches: [ $default-branch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Run a one-line script
        run: echo Hello from Octo Organization
```
workflow-templates ディレクトリ内にメタデータファイルを作成します。メタデータファイルは、ワークフローファイルと同じ名前にする必要がありますが、.yml 拡張子の代わりに、.properties.json を付ける必要があります。たとえば、octo-organization-ci.properties.json という名前のこのファイルには、octo-organization-ci.yml という名前のワークフローファイルのメタデータが含まれます。
```
{
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI starter workflow.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}
```
- name - 必� �。 ワークフローの名前。これは、使用可能なワークフローの一覧に表示されます。
- description - 必� �。 ワークフローの説明。これは、使用可能なワークフローの一覧に表示されます。
- iconName - 省略可能。 ワークフローの一覧に表示されるワークフローのアイコンを指定します。 iconName は、workflow-templates ディレクトリに� �納されている SVG ファイルの名前からファイル名拡張子を除いたものでなければなりません。たとえば、example-icon.svg という名前の SVG ファイルは example-icon として参照されます。
- categories - 省略可能。 ワークフローの言語カテゴリを定義します。ユーザーがリポジトリで使用可能なスターターワークフローを表示すると、プロジェクトで識別された言語に一致するワークフローが、より目立つように表示されます。使用可能な言語カテゴリについては、 https://github.com/github/linguist/blob/master/lib/linguist/languages.yml をご覧く� さい。
- filePatterns - 省略可能。 ユーザーのリポジトリのルートディレクトリに、定義された正規表現に一致するファイルがある� �合、そのワークフローを使用できるようにします。

別のスターターワークフローを追� するには、同じ workflow-templates ディレクトリにファイルを追� します。たとえば次のような点です。

ワークフローファイル

次の手� �

GitHub Actions についてさらに学ぶには、「スターターワークフローの使用」をご覧く� さい。

Organization のスターター ワークフローを作成する

この記事では、次の� �目が扱われます。

概要

スターター ワークフローを作成する

次の手� �

Organization のスターターワークフローを作成する

スターターワークフローを作成する