Organization の GitHub Actions 権限について
既定では、GitHub Actions はすべてのリポジトリと組織で有効になります。 GitHub Actions を無効にするか、または Organization のアクションと再生可能なワークフローに制限することができます。 GitHub Actions について詳しくは、「GitHub Actions について」を参照してください。
Organization のすべてのリポジトリについて GitHub Actions を有効化することができます。 GitHub Actions を有効にすると、ワークフローは、リポジトリ内および他のパブリックリポジトリに配置されているアクションと再利用可能なワークフローを実行できます。 組織のすべてのリポジトリについて、GitHub Actions を無効化できます。 GitHub Actionsを無効化すると、リポジトリでワークフローが実行されなくなります。
または、Organization 内のすべてのリポジトリに対して GitHub Actions を有効にできますが、ワークフローが実行できるアクションと再利用可能なワークフローにアクションを制限できます。
Organization の GitHub Actions 権限の管理
組織内のすべてのリポジトリに対して GitHub Actions を無効にするか、特定のリポジトリのみを許可するかを選択できます。 また、パブリック アクションと再利用可能なワークフローの使用を制限して、Organization 内に存在するローカル アクションと再利用可能なワークフローのみを使用できるようにすることもできます。
注: 組織が、優先ポリシーのあるエンタープライズによって管理されている場合、これらの設定を管理できない場合があります。 詳しくは、「エンタープライズで GitHub Actions のポリシーを適用する」を参照してください。
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。
2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 -
[Policies] で、オプションを選択します。
**[Allow *OWNER*, and select non-*OWNER*, actions and reusable workflows]\(所有者を許可し、非所有者、アクション、再利用可能なワークフローを選択する\)** を選択した場合、組織内のアクションおよび再利用可能なワークフローが許可され、追加のオプションで、その他の特定のアクションや再利用可能なワークフローも許可されます。 詳細については、「[選択したアクションと再利用可能なワークフローの実行の許可](#allowing-select-actions-and-reusable-workflows-to-run)」を参照してください。
組織からのみ再利用可能なワークフローとアクションを許可する場合、ポリシーにより GitHub で作成したアクションへのすべてのアクセスがブロックされます。 たとえば、
actions/checkout
アクションにはアクセスできません。 -
[保存] をクリックします。
選択したアクションと再利用可能なワークフローの実行の許可
[ [Allow OWNER, and select non-OWNER, actions and reusable workflows](所有者を許可し、非所有者、アクション、再利用可能なワークフローを選択する) ] を選ぶと、ローカル アクションと再利用可能なワークフローが許可され、他の特定のアクションや再利用可能なワークフローを許可するための追加のオプションがあります。
-
[GitHub によって作成されたアクションを許可する]: GitHub によって作成されたすべてのアクションを、ワークフローで使用できるようにします。 GitHub によって作成されたアクションは、
actions
およびgithub
組織にあります。 詳しくは、actions
およびgithub
の Organization をご覧ください。 -
[検証済みの作成者による Marketplace アクションを許可する]: 検証済みの作成者が作成したすべての GitHub Marketplace アクションをワークフローで使用できるようにできます。 GitHubがアクションの作者をパートナーOrganizationとして検証すると、GitHub Marketplaceでアクションの隣にバッジが表示されるようになります。
-
[指定したアクションと再利用可能なワークフローを許可する]: ワークフローで使用できるアクションと再利用可能なワークフローを、特定の組織とリポジトリのものに制限します。
アクションまたは再利用可能なワークフローの特定のタグまたはコミット SHA へのアクセスを制限するには、ワークフローで使われているのと同じ構文を使って、アクションまたは再利用可能なワークフローを選びます。
- アクションの場合の構文は、
<OWNER>/<REPO>@<TAG OR SHA>
です。 たとえば、タグを選択するにはactions/javascript-action@v1.0.1
を使用し、SHA を選択するにはactions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f
を使用します。 詳しくは、「アクションの検索とカスタマイズ」を参照してください。 - 再利用可能なワークフローの場合の構文は、
<OWNER>/<REPO>/<PATH>/<FILENAME>@<TAG OR SHA>
です。 たとえば、octo-org/another-repo/.github/workflows/workflow.yml@v1
のように指定します。 詳しくは、「ワークフローの再利用」を参照してください。
パターンのマッチには、ワイルドカード文字
*
を使用できます。 たとえば、space-org
で始まる Organization のすべてのアクションと再利用可能なワークフローを許可するには、space-org*/*
と指定できます。 octocat で始まるリポジトリのすべてのアクションと再利用可能なワークフローを許可するには、*/octocat**@*
を使用できます。*
ワイルドカードの使用の詳細については、「GitHub Actions のワークフロー構文」を参照してください。注: [指定したアクションと再利用可能なワークフローを許可する] オプションを使用できるのは、GitHub Free、GitHub Pro、Organization の GitHub Free、または GitHub Team プランのパブリック リポジトリのみです。
- アクションの場合の構文は、
この手順では、特定のアクションと再利用可能なワークフローを許可リストに追加する方法を示します。
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。
2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 -
[ポリシー] で [ [Allow OWNER, and select non-OWNER, actions and reusable workflows](所有者を許可し、非所有者、アクション、再利用可能なワークフローを選択する) ] を選び、必要なアクションと再利用可能なワークフローを一覧に追加します。
-
[保存] をクリックします。
パブリックフォークからのワークフローに対する必須の承認の設定
パブリックリポジトリをフォークし、リポジトリのGitHub Actionsワークフローへの変更を提案するPull Requestをサブミットすることは誰でもできます。 フォークからのワークフローはシークレットなどの機密データにアクセスできませんが、悪用目的で変更された場合、メンテナが迷惑を被る可能性があります。
これを防ぐために、外部コラボレータのパブリックリポジトリへのPull Requestではワークフローは自動的には動作せず、まず承認が必要になることがあります。 デフォルトでは、すべての初めてのコントリビューターは、ワークフローを実行するのに承認を必要とします。
注: pull_request_target
イベントによってトリガーされるワークフローは、ベース ブランチのコンテキストで実行されます。 ベース ブランチは信頼済みと見なされるため、承認設定に関係なく、これらのイベントによってトリガーされるワークフローは常に実行されます。
Organizationのこの動作は、以下の手順で設定できます。 この設定を変更すると、Enterpriseレベルでの設定が上書きされます。
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。
2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 1. [外部コラボレーターからの pull request ワークフローのフォーク] の下で、オプションを選択します。 このオプションは、制限が緩いものから厳しいものへとリストされています。 -
[保存] をクリックして設定を適用します。
このポリシーが適用されるワークフロー実行の承認の詳細については、「パブリックフォークで実行されるワークフローの実行を承認する」を参照してください。
Organization に必要なワークフローを追加する
メモ: 必要なワークフローは現在ベータ版であり、変更される可能性があります。
ご自分が所有者である Organization 内のすべてのリポジトリ、または選んだリポジトリで実行するように、必要なワークフローを構成できます。 必須のワークフローは pull_request
および pull_request_target
既定イベント によってトリガーされます。pull request をマージするには必須のワークフローを通過する必要があります。 詳しくは、「必要なワークフロー」を参照してください。
前提条件
必要なワークフローを構成する前に、次の前提条件にご注意ください。
- 必要なワークフローが実行されるように、Organization の設定で、リポジトリに対して GitHub Actions を有効にする必要があります。 Organization レベルで有効にすると、リポジトリの設定で GitHub Actions が無効になっている場合にも、必要なワークフローが実行されます。 組織のリポジトリでの GitHub Actions の管理の詳細については、「Organization について GitHub Actions を無効化または制限する」を参照してください。
- 必要なワークフローは、必須ステータス チェックが Organization の計画でサポートされているリポジトリ内でのみ、Organization で使うことができます。 必須ステータス チェックがサポートされていない場合、ワークフローは引き続き実行されますが、必須のチェックにはならず、マージはブロックされません。 必要なステータス チェックのサポートの詳細については、「保護されたブランチについて」を参照してください。
- 必要なワークフローが必須ステータス チェックとして実行されるように、リポジトリの既定のブランチは、Organization の既定のブランチの設定と一致している必要があります。 既定のブランチ名が一致していない場合、ワークフローは引き続き実行されますが、必須チェックにはなりません。 既定のブランチ名の管理の詳細については、「Organization のリポジトリのデフォルブランチ名を管理する」と「デフォルトブランチを変更する」を参照してください。
- 必要なワークフローを実行するには、pull request のソース リポジトリがターゲット リポジトリと同じ Organization に存在している必要があります。 GitHub は、ワークフローを含むリポジトリの指定されたブランチ、タグ、またはコミット SHA から必要なワークフローをソースにします。
- 必要なワークフローで使うシークレットは、Organization レベルかターゲット リポジトリ内で作成する必要があります。
- ソース リポジトリ内のシークレットは、ワークフローがターゲット リポジトリ内で実行される場合にはフェッチされません。
ソース リポジトリの制限と動作
ソース リポジトリとワークフローに関する次の制限と動作にご注意ください。
-
必要なワークフローは、任意のリポジトリ フォルダーに格納可能で、通常のワークフローのように
.github/workflows
フォルダーに限定されることはありません。 必要なワークフローが再利用可能なワークフローを呼び出す場合は、その再利用可能なワークフローを.github/workflows
フォルダーに格納する必要があります。 再利用可能なワークフローを呼び出すときは、再利用可能なワークフローへの完全なパスと参照を、必要なワークフローで使う必要があります。 たとえば、「{owner}/{repo}/.github/workflows/{filename}@{ref}
」のように入力します。 -
必要なワークフローがプライベート リポジトリリポジトリに含まれている場合は、リポジトリ内のワークフローが Organization 内の他のリポジトリからアクセスできるようにする必要があります。 詳細については、「リポジトリの GitHub Actions の設定を管理する」を参照してください。
-
パブリック リポジトリに格納されているワークフローは、Organization 内の任意のリポジトリの必要なワークフローとして構成できます。 プライベート リポジトリに格納されているワークフローは、Organization 内の他のプライベート リポジトリの必要なワークフローとして構成できます。
-
CodeQL は、リポジトリ レベルでの構成を必要とするため、必要なワークフローではサポートされていません。 コード スキャンの構成については、「リポジトリの code scanning を構成する」を参照してください。
-
必要なワークフローが組織レベルで適用されているブランチにプッシュするには、pull request を作成して必要な変更を行います。 ワークフローの適用が必要なブランチに直接プッシュすることはできません。
-
特定のリポジトリに対して直接プッシュを許可する場合は、それぞれの必要なワークフローからリポジトリをターゲットとして削除する必要があります。
-
必要なワークフローは、ワークフロー ファイルを含むリポジトリから任意のブランチ、タグ、またはコミット SHA を使用して参照できます。
ターゲット リポジトリの制限と動作
ターゲット リポジトリの次の制限と動作にご注意ください。
- 必要なワークフローをすべてのリポジトリで、または選択したリポジトリで実行されるように構成する場合、この必要なワークフローを含むリポジトリの可視性は、ワークフローを実行している Organization 内のリポジトリに影響します。 パブリック リポジトリに格納されている必要なワークフローは、すべてのリポジトリで実行されます。 プライベート リポジトリに格納されている必要なワークフローは、他のプライベート リポジトリで実行されます。
- 必要なワークフローを、このワークフローが作成されたリポジトリで実行されるように構成することはできません。 必要なワークフローを格納するには、別のリポジトリの作成を検討する必要があります。
- 必要なワークフローをすべてのリポジトリで、または選択したリポジトリで実行されるように構成する場合、必要なワークフローは、Organization の設定でアクションが無効になっているリポジトリでは実行されません。
Organization に必要なワークフローの構成
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。
2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 -
[必須のワークフロー] の右側にある [ワークフローの追加] を選択します。
-
[必須のワークフロー] で、ドロップダウン メニューを使用して、ワークフローを含むリポジトリを選択します。 次に、テキスト フィールドにワークフローへのパスを入力します。
{path}@{ref}
構文を使用して、ワークフロー ファイルを含むリポジトリから任意のブランチ、タグ、またはコミット SHA を参照できます。 -
必要に応じて、必須のワークフローを適用するターゲット ブランチを指定するには、[ターゲット ブランチ] の下のテキスト フィールドにブランチまたは複数のブランチを入力します。 ターゲット ブランチを入力しない場合は、必須のワークフローがリポジトリの既定のブランチに適用されます。
-
[リポジトリに適用...] で、ドロップダウン メニューを使用して、必須のワークフローが適用されるリポジトリを選択します。 [すべてのリポジトリ] を選んで、組織内のすべてのリポジトリに必須のワークフローを適用するか、または [選択済みのリポジトリ] で適用するリポジトリを選びます。
-
必要に応じて、[選択済みのリポジトリ] を選んだ場合は、 を選択してリポジトリの選択モーダルを開き、チェックボックスを使用してリポジトリを選んでから、 [選択の適用] を選択します。 フィルターを使用すると検索を絞り込むことができます。
-
必要なワークフローを追加するには、 [ワークフローの追加] をクリックします。
プライベートリポジトリのフォークのワークフローを有効にする
プライベート リポジトリのフォークの利用に依存している場合、pull_request
イベントの際にユーザーがどのようにワークフローを実行できるかを制御するポリシーを構成できます。 プライベート リポジトリでのみ使用でき、組織またはリポジトリに対してこれらのポリシー設定を構成できます。
Organizationでポリシーが無効化されていると、それをリポジトリで有効化することはできません。 Organizationがポリシーを有効化していると、そのポリシーを個々のリポジトリで無効化することはできません。
- フォーク pull request からワークフローを実行する - 読み取り専用権限を持ち、シークレットへのアクセス権を持たない
GITHUB_TOKEN
を使用して、フォーク pull request からワークフローを実行できます。 - pull request からワークフローに書き込みトークンを送信する - フォークからの pull request で書き込み権限を持つ
GITHUB_TOKEN
を使用できます。 - pull request からワークフローにシークレットを送信する - すべてのシークレットを pull request で利用できるようにします。
- フォークの pull request ワークフローに対して承認を要求する - 書き込みアクセス許可のないコラボレーターからの pull request に対するワークフロー実行には、実行する前に書き込みアクセス許可を持つ誰かからの承認が必要になります。
Organization のプライベートフォークポリシーを設定する
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。
2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 1. [Fork pull request workflows](pull request ワークフローのフォーク) で、オプションを選択します。 -
[保存] をクリックして設定を適用します。
組織の GITHUB_TOKEN
のアクセス許可の設定
GITHUB_TOKEN
に付与される既定のアクセス許可を設定できます。 GITHUB_TOKEN
について詳しくは、「自動トークン認証」をご覧ください。 デフォルトとして制限付きアクセス許可セットを選択するか、より幅広く許可をする設定を適用できます。
組織またはリポジトリの設定で、GITHUB_TOKEN
の既定のアクセス許可を設定できます。 Organization の設定でデフォルトとして制限付きのオプションを選択した場合、そのオプションは Organization 内のリポジトリの設定でも選択され、制限の緩いオプションは無効化されます。 Organization が GitHub Enterprise に属しており、Enterprise 設定でさらに制約の強いデフォルトが選択されている場合、Organization の設定でより制限の緩いデフォルトは選択できません。
リポジトリへの書き込みアクセス権を持っている人は誰でも、ワークフロー ファイルの permissions
キーを編集して、GITHUB_TOKEN
に付与されたアクセス許可を変更でき、必要に応じて追加または削除できます。 詳細については、permissions
をご覧ください。
既定の GITHUB_TOKEN
のアクセス許可の構成
既定では、新しい Organization を作成すると、 GITHUB_TOKEN
が持っているのは、contents
スコープと packages
スコープに対する読み取りアクセスのみです。
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分のプロファイル] をクリックします。
1. GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。 2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 -
[ワークフローのアクセス許可] で、
GITHUB_TOKEN
に対してすべてのスコープでの読み取りと書き込みアクセスを許可するか、contents
スコープとpackages
スコープでの読み取りアクセスのみを許可するかを選びます。 -
[保存] をクリックして設定を適用します。
GitHub Actions による pull request の作成または承認を禁止する
GitHub Actions ワークフローが pull request を作成または承認することを許可または禁止するかを選択できます。
既定では、新しい Organization を作成するとき、ワークフローで pull request を作成または承認することは許可されていません。
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分のプロファイル] をクリックします。
1. GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。 2. 組織の隣の [設定] をクリックします。 1. 左側のサイドバーで、 [アクション] 、 [全般] の順にクリックします。 -
[ワークフローのアクセス許可] で、 [GitHub Actions が pull request を作成または承認するのを許可する] 設定を使って、
GITHUB_TOKEN
が pull request を作成または承認できるかどうかを構成します。 -
[保存] をクリックして設定を適用します。
Organization の GitHub Actions キャッシュ ストレージの管理
Organization の管理者は GitHub Actions Organization 内のすべてのリポジトリのキャッシュ ストレージを管理できます。
リポジトリごとの GitHub Actions キャッシュ ストレージの表示
Organization 内の各リポジトリについて、リポジトリが使用しているキャッシュ ストレージの量、アクティブなキャッシュの数、リポジトリがキャッシュ サイズの合計の上限に近いかどうかを確認できます。 キャッシュの使用と削除のプロセスについて詳しくは、「依存関係をキャッシュしてワークフローのスピードを上げる」を参照してください。
-
GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分のプロファイル] をクリックします。
1. GitHub.com の右上隅にあるプロファイル写真をクリックし、 [自分の Organization] をクリックします。 2. 組織の隣の [設定] をクリックします。 -
左のサイドバーで [アクション] をクリックし、 [キャッシュ] をクリックします。
-
GitHub Actions キャッシュの情報については、リポジトリのリストをご確認ください。 リポジトリ名をクリックすると、リポジトリのキャッシュの詳しい情報を表示できます。