This action reports the remaining rate-limit for the GitHub API. Running this action will provide output for consumed and remaining rate-limit for the GitHub token used to run the action. This action is useful for debugging rate-limit issues with GitHub Actions or to use the rate-limit in subsequent steps, such as logging the rate-limit to an external service or waiting for the rate-limit to reset before continuing with the workflow.

Accepts a GitHub token as input and render flag to render the output as step summary output.

String, Required, The GitHub token to use for authentication.

String, Optional, Render the output to the job's step summary. Defaults to 'true'.

The render option will generate output similar to the following:

The rate-limit object returned by the GitHub API for the provided token.

Example with rendering the output as step summary output:

- name: Report rate-limit
  uses: collinmcneese/actions-rate-limit-reporter@main
  with:
    access-token: ${{ secrets.GITHUB_TOKEN }}

Example using this Action in a step and then using the output in a subsequent step:

- name: Report rate-limit
  id: report-rate-limit
  uses: collinmcneese/actions-rate-limit-reporter@main
  with:
    access-token: ${{ secrets.GITHUB_TOKEN }}
- name: Do something with the rate-limit
  run: echo "The rate-limit remaining for core is ${{ fromJson(steps.report-rate-limit.outputs.rateLimitObject).resources.core.remaining }}"