GitHub - arduino/report-size-deltas: GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches (original) (raw)
arduino/report-size-deltas action
This action comments on the pull request with a report on the resulting change in memory usage of the Arduino sketches compiled by the arduino/compile-sketches action. This should be run from a scheduled workflow.
Table of contents
Inputs
sketches-reports-source
Default: "sketches-reports"
The action can be used in two ways:
Run from a scheduled workflow
Recommended for public repositories.
The use of a scheduled workflow is necessary in order for the action to have the 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.
Run from the same workflow as the arduino/compile-sketches action
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-token
GitHub access token used to comment the memory usage comparison results to the PR thread.
Default: GITHUB_TOKEN
Example usage
Scheduled workflow
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 arduino/compile-sketches action and uploads the resulting sketches report to a 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.
Workflow triggered by pull_request event
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.