Skip to content

Commit 4cb130d

Browse files
authored
Merge pull request #3 from per1234/update-docs
Fix typos and outdated documentation
2 parents ff02073 + 5d086b3 commit 4cb130d

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# libraries/report-size-deltas action
1+
# arduino/report-size-deltas action
22

3-
This action comments on the pull request with a report on the change in memory usage of an example sketch. This should be run from a [scheduled workflow](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule).
3+
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).
44

55
## Inputs
66

77
### `size-deltas-reports-artifact-name`
88

9-
Name of the workflow artifact that contains the memory usage data, as specified to the actions/upload-artifact action via the name argument. Default "size-deltas-reports".
9+
Name of the workflow artifact that contains the memory usage data, as specified to the [`actions/upload-artifact`](https://github.com/actions/upload-artifact) action via its `name` input. Default "size-deltas-reports".
1010

1111
### `github-token`
1212

@@ -22,5 +22,5 @@ jobs:
2222
build:
2323
runs-on: ubuntu-latest
2424
steps:
25-
- uses: arduino/actions/libraries/report-size-deltas@master
25+
- uses: arduino/report-size-deltas@master
2626
```

action.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
name: 'Arduino Libraries - Report Size Deltas'
2-
description: 'Comments on the pull request with a report on the change in memory usage of an example sketch'
1+
name: 'Report Arduino Sketch Size Deltas'
2+
description: 'Comments on the pull request with a report on the resulting change in memory usage of Arduino sketches'
33
inputs:
44
size-deltas-reports-artifact-name:
5-
description: 'Name of the workflow artifact that contains the memory usage data, as specified to the actions/upload-artifact action via the name argument'
5+
description: 'Name of the workflow artifact that contains the memory usage data, as specified to the actions/upload-artifact action via its name input'
66
default: 'size-deltas-reports'
77
github-token:
88
description: 'GitHub access token used to comment the memory usage comparison results to the PR thread'

0 commit comments

Comments
 (0)