googleapis / release-please-action

automated releases based on conventional commits
Apache License 2.0
1.67k stars 206 forks source link

Documentation appears to contradict itself #972

Closed KernelDeimos closed 5 months ago

KernelDeimos commented 5 months ago

TL;DR

Documentation appears to suggest that token must be specified for GitHub Actions, and if it's not specified it will use GITHUB_TOKEN (which implies token does not need to be specified)

Expected behavior

Clear documentation about what happens when a token is not specified.

Observed behavior

These two statements:

If using GitHub Actions, you will need to specify a token for your workflows

By default, Release Please uses the built-in GITHUB_TOKEN secret.

Action YAML

N/A

Log output

No response

Additional information

No response

KernelDeimos commented 5 months ago

I figured out what's up; the documentation is specifically talking about explicitly allowing recursive behavior.