Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arduino/report-size-deltas
GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
https://github.com/arduino/report-size-deltas
arduino ci continuous-integration github-actions tooling-team
Last synced: about 1 month ago
JSON representation
GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
- Host: GitHub
- URL: https://github.com/arduino/report-size-deltas
- Owner: arduino
- License: other
- Created: 2020-09-03T13:41:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T09:00:36.000Z (about 2 months ago)
- Last Synced: 2024-09-29T08:26:59.988Z (about 2 months ago)
- Topics: arduino, ci, continuous-integration, github-actions, tooling-team
- Language: Python
- Homepage:
- Size: 572 KB
- Stars: 14
- Watchers: 7
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `arduino/report-size-deltas` action
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-markdown-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-npm-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-poetry-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-prettier-formatting-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-python-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-taskfiles.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/check-toc-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/test-integration.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/spell-check-task.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/sync-labels-npm.yml)
[](https://github.com/arduino/report-size-deltas/actions/workflows/test-python-poetry-task.yml)
[](https://codecov.io/gh/arduino/report-size-deltas)
This action comments on the pull request with a report on the resulting change in memory usage of the [Arduino](https://www.arduino.cc/) sketches compiled by the [`arduino/compile-sketches`](https://github.com/arduino/compile-sketches) action. This should be run from a [scheduled workflow](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule).
## Table of contents
- [Inputs](#inputs)
- [`sketches-reports-source`](#sketches-reports-source)
- [Run from a scheduled workflow](#run-from-a-scheduled-workflow)
- [Run from the same workflow as the `arduino/compile-sketches` action](#run-from-the-same-workflow-as-the-arduinocompile-sketches-action)
- [`github-token`](#github-token)
- [Example usage](#example-usage)
- [Scheduled workflow](#scheduled-workflow)
- [Workflow triggered by `pull_request` event](#workflow-triggered-by-pull_request-event)
- [Additional resources](#additional-resources)
## 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](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule) is necessary in order for the action to have the [write permissions required to comment on pull requests submitted from forks](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
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`](https://github.com/actions/upload-artifact) action via its `name` input.
The regular expression syntax is [that of the Python `re` module](https://docs.python.org/3.11/library/re.html#regular-expression-syntax).
#### 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](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) 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](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) 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`](https://github.com/actions/download-artifact) action via its `path` input.
The path is searched recursively for sketches report files.
### `github-token`
[GitHub access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) used to comment the memory usage comparison results to the PR thread.
**Default**: [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
## Example usage
### Scheduled workflow
```yaml
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`](https://github.com/arduino/compile-sketches) action and uploads the resulting sketches report to a [workflow artifact](https://help.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts):
```yaml
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**](docs/FAQ.md#size-deltas-report-workflow-triggered-by-schedule-event).
---
### Workflow triggered by `pull_request` event
```yaml
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**](docs/FAQ.md#workflow-triggered-by-pull_request-event).
---
## Additional resources
- [Introductory article about **arduino/report-size-deltas**](https://blog.arduino.cc/2021/04/09/test-your-arduino-projects-with-github-actions/)
- [Frequently asked questions about **arduino/report-size-deltas**](docs/FAQ.md#frequently-asked-questions)
- [**GitHub Actions** documentation](https://docs.github.com/actions/learn-github-actions/understanding-github-actions)
- [Discuss or request assistance on **Arduino Forum**](https://forum.arduino.cc/)