パーミッション

このセクションでは、GitHubのワークフローが行える権限を設定する「パーミッション」について説明します。

1. パーミッションとは

パーミッションは、ワークフローが GitHub のリソースにアクセスする際に、どこまでの権限を許可するかを制御する仕組みです。ワークフローの中で行われる操作が、GitHub 上のどのリソースにどのレベルでアクセスできるかを明確に指定します。

GitHub Actions からは、contents、pull-requests、actions といった GitHub のリソースに対して操作を行うことができます。それぞれのリソースに対して、read、write、none のいずれかの権限を割り当てます。read は参照のみ、write は更新が可能、none は参照も更新もできないという意味です。権限を省略した場合は、基本的に read 権限が付与されますが、一部のリソースでは none が付与されるものもあります。

2. よくあるパーミッション

よくある権限として、contents に write 権限を与えると、リポジトリへの push や release の作成、tags の作成や削除といった操作が許可されます。pull-requests に write 権限を付与すると、プルリクエストへのコメント投稿や編集、ラベルの付与、マージなどが実行できます。actions の write 権限では、ワークフローの再実行、別のワークフローの起動、アーティファクトの操作などが可能になります。

3. パーミッションの定義

パーミッションの定義は、permissions ブロックを使って記述します。

permissions:
  contents: write
  pull-requests: write
  actions: read

この例では、contents と pull-requests に write 権限を、actions に read 権限を付与しています。

また、パーミッションにはスコープがあり、ワークフロー全体に対して権限を指定する方法と、特定のジョブだけに対して権限を設定する方法があります。

jobs:
  deploy:
    permissions:
      contents: write
    steps:
      - run: echo "このジョブだけcontentsへのwrite権限を持つ"

必要な操作が限定されている場合は、このようにジョブ単位で権限を細かく調整することで、より安全な構成にできます。

このように、パーミッションは GitHub Actions のセキュリティや制御性を高めるために欠かせない仕組みです。必要な権限だけを適切に付与し、最小権限の原則に沿って設定していくことが重要になります。