Document which parameters will require pagination to avoid rate limiting

[sidx1024]

We've seen quite a few times that we're rate limited by GitHub due to multiple API calls. This happens in cases where we have to paginate across results for listWorkflowRuns request.

Example

Usage A.

  workflow: 'my-workflow.yml'
  workflow_conclusion: success
  commit: ${{ github.event.pull_request.base.sha }}

Usage B.

  workflow: 'my-workflow.yml'
  workflow_conclusion: success
  branch: ${{ github.event.pull_request.base.ref }}

Here, the usage B will be more efficient as branch is an accepted parameter for listWorkflowRuns request.

[adam-mrozik]

Just FYI, happens to me as well and I am using branch, not commit. But, I am using "search_artifacts" option

[lukasz-mitka]

Actually commit: version could be vastly improved by using listWorkflowRuns with head_sha parameter.
#226

[lukasz-mitka]

@sidx1024 #227 has been merged and released.
commit should no longer trigger so many API calls.

Just an FYI since documentation could still be useful for other options.