Skip to content

Commit af41e45

Browse files
committed
Format the documentation to make default input values easy to find
Previously, the information on whether an input had a default value -- and if so, what -- was incorporated into the input description. This meant you had to read the entire description to find this information. When using other actions, I have regularly had difficulty determining which inputs are required and default input values. I would like for the users of this action to not have that experience.
1 parent dde341e commit af41e45

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ This action comments on the pull request with a report on the resulting change i
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`](https://github.com/actions/upload-artifact) action via its `name` input. 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.
10+
11+
**Default**: `"size-deltas-reports"`
1012

1113
### `github-token`
1214

13-
GitHub 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).
15+
GitHub access token used to comment the memory usage comparison results to the PR thread.
16+
17+
**Default**: [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token).
1418

1519
## Example usage
1620

0 commit comments

Comments
 (0)