ノート: GitHub Actionsは、GitHub Enterprise Server 2.22で限定ベータとして利用可能でした。 ベータは終了しました。 GitHub Actionsは、GitHub Enterprise Server 3.0以降で一般に利用可能になりました。 詳しい情報については、GitHub Enterprise Server 3.0 のリリースノートを参照してください。
- GitHub Enterprise Server 3.0以降へのアップグレードに関する詳しい情報については「GitHub Enterprise Serverのアップグレード」を参照してください。
- アップグレード後のGitHub Actionsの設定に関する詳しい情報については、GitHub Enterprise Server 3.0のドキュメンテーションを参照してください。
ノート: GitHubホストランナーは、現在GitHub Enterprise Serverでサポートされていません。 GitHubパブリックロードマップで、計画されている将来のサポートに関する詳しい情報を見ることができます。
概要
Workflow templates allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When you create a new workflow, you can choose a template and some or all of the work of writing the workflow will be done for you. ワークフローテンプレートは、カスタムワークフローの構築の出発点として利用することも、そのまま利用することもできます。 This not only saves time, it promotes consistency and best practice across your organization.
ワークフロー テンプレートの作成
ワークフローテンプレートは、Organizationの .github
リポジトリへの書き込みアクセス権を持つユーザが作成できます。 その後、ワークフローを作成する権限を持つOrganizationのメンバーがテンプレートを使用できます。 You can share workflow templates if your organization's repository is public or if the repository is private and on an Enterprise plan.
この手順では、ワークフロー テンプレートとメタデータ ファイルを作成する方法を示します。 メタデータ ファイルには、ユーザが新しいワークフローを作成するときにテンプレートがどのように表示されるかについて説明します。
-
存在しない場合は、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 workflow template.", "iconName": "example-icon", "categories": [ "Go" ], "filePatterns": [ "package.json$", "^Dockerfile", ".*\\.md$" ] }
name
- 必須。 ワークフロー テンプレートの名前。 これは、使用可能なテンプレートの一覧に表示されます。description
- 必須。 ワークフロー テンプレートの説明。 これは、使用可能なテンプレートの一覧に表示されます。iconName
- 必須。 テンプレート リスト内のワークフローのエントリのアイコンを定義します。iconName
は、同じ名前の SVG アイコンである必要があり、workflow-templates
ディレクトリに格納する必要があります。 たとえば、example-icon.svg
という名前の SVG ファイルは、example-icon
として参照されます。categories
- オプション。 ワークフローの言語カテゴリを定義します。 ユーザーが使用可能なテンプレートを表示する際に、同じ言語に一致するテンプレートが目立つようにになります。 使用可能な言語カテゴリについては、「https://github.com/github/linguist/blob/master/lib/linguist/languages.yml」を参照してください。filePatterns
- オプション 。 定義された正規表現に一致するファイルがユーザーのリポジトリのルート ディレクトリにある場合に、テンプレートを使用できるようにします。
別のワークフロー テンプレートを追加するには、同じ workflow-templates
ディレクトリにファイルを追加します。 例:
次のステップ
To continue learning about GitHub Actions, see "Using workflow templates."