search

repo-sync / pull-request

⤵️ A GitHub Action for creating pull requests
https://github.com/marketplace/actions/github-pull-request-action
MIT License
347 stars 129 forks source link

GITHUB_TOKEN permissions used by this action #81

Closed step-security-bot closed 1 year ago

step-security-bot commented 2 years ago

At https://github.com/step-security/secure-workflows we are building a knowledge-base (KB) of GITHUB_TOKEN permissions needed by different GitHub Actions. When developers try to set minimum token permissions for their workflows, they can use this knowledge-base instead of trying to research permissions needed by each GitHub Action they use.

Below you can see the KB of your GITHUB Action.

name: GitHub Pull Request Action
github-token:
  action-input:
    input: github_token
    is-default: false
  permissions:
    pull-requests: write
    pull-requests-reason: to create pull requests #Checkout: https://github.com/repo-sync/pull-request#features

#Fixes #497

If you think this information is not accurate, or if in the future your GitHub Action starts using a different set of permissions, please create an issue at https://github.com/step-security/secure-workflows/issues to let us know.

This issue is automatically created by our analysis bot, feel free to close after reading :)

References:

GitHub asks users to define workflow permissions, see https://github.blog/changelog/2021-04-20-github-actions-control-permissions-for-github_token/ and https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token for securing GitHub workflows against supply-chain attacks.

Setting minimum token permissions is also checked for by Open Source Security Foundation (OpenSSF) Scorecards. Scorecards recommend using https://github.com/step-security/secure-workflows so developers can fix this issue in an easier manner.

wei commented 2 years ago

Great one! PR Welcome