This action comments on the pull request with a report on the resulting change in memory usage of the Arduino sketches compiled by the scheduled workflow.

• Inputs
  • sketches-reports-source
    • Run from a scheduled workflow
    • Run from the same workflow as the arduino/compile-sketches action
  • github-token
• Example usage
  • Scheduled workflow
  • Workflow triggered by pull_request event
• Additional resources

Default: "sketches-reports"

The action can be used in two ways:

Recommended for public repositories.

The use of a write permissions required to comment on pull requests submitted from forks.

In this usage, the sketches-reports-source input defines the regular expression matching the names of the workflow artifacts that contain the memory usage data, as specified to the actions/upload-artifact action via its name input.

The regular expression syntax is that of the Python re module.

Recommended for private repositories.

If configured to trigger on a short interval, the scheduled workflow method can use a lot of GitHub Actions minutes, quickly using up the limited allotment provided by GitHub for private repositories (public repositories get unlimited free minutes). For this reason, it may be preferable to only run the action as needed.

In order to get reports for pull requests from forks, the "Send write tokens to workflows from fork pull requests" setting must be enabled.

If the "Send write tokens to workflows from fork pull requests" setting is not enabled but the "Run workflows from fork pull requests" setting is enabled, the workflow should be configured to only run the action when the pull request is not from a fork (if: github.event.pull_request.head.repo.full_name == github.repository). This will prevent workflow job failures that would otherwise be caused when the report creation failed due to not having the necessary write permissions.

In this usage, the sketches-reports-source defines the path to the folder containing the memory usage data, as specified to the actions/download-artifact action via its path input.

The path is searched recursively for sketches report files.

GitHub access token used to comment the memory usage comparison results to the PR thread.

Default: GITHUB_TOKEN

on:
  schedule:
    - cron: "*/5 * * * *"
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: arduino/report-size-deltas@v1

This must be used in conjunction with a workflow that runs the workflow artifact:

on: [push, pull_request]
jobs:
  compile:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: arduino/compile-sketches@v1
        with:
          enable-deltas-report: true
      - uses: actions/upload-artifact@v4
        with:
          name: sketches-reports
          path: sketches-reports

ⓘ A more advanced example is available in the FAQ.

on: [push, pull_request]
jobs:
  compile:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: arduino/compile-sketches@v1
        with:
          enable-deltas-report: true
      - uses: arduino/report-size-deltas@v1
        # Only run the action when the workflow is triggered by a pull request.
        if: github.event_name == 'pull_request'

ⓘ A more advanced example is available in the FAQ.

• Introductory article about arduino/report-size-deltas
• Frequently asked questions about arduino/report-size-deltas
• GitHub Actions documentation
• Discuss or request assistance on Arduino Forum