Using gh in an workflow seems to require setting GH_TOKEN

[mkutz]

[maintainer edit]
This issue is reserved for the MLH Fellowship program.

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions

What part(s) of the article would you like to see updated?

When I try the suggested workflows I get an error as gh seems to need the GITHUB_TOKEN to be set as GH_TOKEN.

The following works:

      - name: Approve a PR
        run: gh pr review --approve "$PR_URL"
        env:
          PR_URL: ${{github.event.pull_request.html_url}}
          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

Additional information

The repo in question is private and within an organization.

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[stefanscheidt]

Part of the error message shown in the GitHub workflow log when omitting the GH_TOKEN env var:

gh: To use GitHub CLI in a GitHub Actions workflow, set the GH_TOKEN environment variable. Example:
  env:
    GH_TOKEN: ${{ github.token }}
Error: Process completed with exit code 4.

[mchammer01]

@cmwilson21 - this requires review by a SME so I've added the relevant label 😃

[github-actions]

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

[mchammer01]

Thank you @mkutz for raising this with us, and @stefanscheidt for confirming the docs are currently incorrect ✨
If you (@mkutz) or someone else in the community are happy to raise a PR that fixes this, it would be great!

For information, the Dependabot team mentioned this article: https://docs.github.com/en/actions/security-guides/automatic-token-authentication

[cmwilson21]

This issue is reserved for the MLH Fellowship program.

[github-actions]

A stale label has been added to this issue becuase it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.