組織のワークフローテンプレートを作成する

概要

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

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

デプロイ (CD) 。詳しくは、「Continuous deployment」をご覧ください。

セキュリティ。詳細については、「コードスキャンの高度なセットアップの構成」を参照してください。

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

メモ

ワークフローテンプレートにはパブリック .github リポジトリが必要であるため、Enterprise Managed Users では使用できません。

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

組織の_パブリック_ .github リポジトリへの書き込みアクセス権限を持つユーザーは、ワークフローテンプレートを作成できます。その後、ワークフローを作成するアクセス許可を持つ組織のメンバーはそれを使用できます。

ユーザーが作成したワークフローテンプレートは、パブリックリポジトリ内のワークフローの作成にのみ使用できます。 GitHub Enterprise Cloud を使っている組織は、ワークフローテンプレートを使ってプライベートリポジトリのワークフローを作成することもできます。詳細については、GitHub Enterprise Cloud ドキュメントを参照してください。

メモ

ワークフローテンプレート間の重複を避けるために、ワークフロー内から再利用可能なワークフローを呼び出すことができます。これにより、ワークフローの管理を容易にできます。詳しくは、「Reuse workflows」をご覧ください。

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

それがまだない場合は、組織で .github という名前の新しい_パブリック_ リポジトリを作成します。
workflow-templates という名前のディレクトリを作成します。

workflow-templates ディレクトリ内に新しいワークフローファイルを作成します。

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

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

YAML

name: Octo Organization CI

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

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Run a one-line script
        run: echo Hello from Octo Organization

name: Octo Organization CI

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

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - 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 という名前のワークフローファイルのメタデータが含まれます。
JSON
```
{
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI workflow template.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}
```
```
{
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI workflow template.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}
```
- name - 必須。 ワークフローの名前。これは、使用可能なワークフローの一覧に表示されます。
- description - 必須。 ワークフローの説明。これは、使用可能なワークフローの一覧に表示されます。
- iconName - 省略可能。 ワークフローの一覧に表示されるワークフローのアイコンを指定します。 iconName には次のいずれかの種類を指定できます。
  - workflow-templates ディレクトリに格納されている SVG ファイル。ファイルを参照するには、その値がファイル拡張子のないファイル名である必要があります。たとえば、example-icon.svg という名前の SVG ファイルは example-icon として参照されます。
  - GitHub の Octicons セットからのアイコン。 octicon を参照するには、値を octicon <icon name> にする必要があります。たとえば、「 octicon smiley 」のように入力します。
- categories - 省略可能。 ワークフローが表示されるカテゴリを定義します。次の一覧からのカテゴリ名を使用できます。
  - starter-workflows リポジトリの一般的なカテゴリ名。
  - linguist リポジトリの一覧からの Linguist 言語。
  - starter-workflows リポジトリの一覧からのサポートされている技術スタック。
- filePatterns - 省略可能。 ユーザーのリポジトリのルートディレクトリに、定義された正規表現に一致するファイルがある場合、そのワークフローを使用できるようにします。

別のワークフローテンプレートを追加するには、同じ workflow-templates ディレクトリにファイルを追加します。

次のステップ

GitHub Actions について詳しくは、「ワークフローテンプレートの使用」をご覧ください。

組織のワークフロー テンプレートを作成する

この記事の内容

概要

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

次のステップ

組織のワークフローテンプレートを作成する

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