Skip to content

Commit 4b64335

Browse files
authored
chore(doc): update examples to include name for action
Add `name` parameter to the examples so that the action presentation on github is nicer - shows the name of the action rather than the workflow filename and path. Resolves arduino#11 if I understand the issue correctly, as there actually isn't an `arduino-lint.yml` file in this repo, but I think the OP was confusing this with the example snippet.
1 parent 0d29e84 commit 4b64335

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ GitHub access token used to get information from the GitHub API.
115115
The minimal workflow to run the default checks on the projects in the repository:
116116

117117
```yaml
118+
name: arduino-lint
118119
on: [push, pull_request]
119120
jobs:
120121
lint:
@@ -127,6 +128,7 @@ jobs:
127128
A more complex workflow which uses [inputs](#inputs) to configure the action for Library Manager ["update" mode](#library-manager) and strict compliance:
128129
129130
```yaml
131+
name: arduino-lint
130132
on: [push, pull_request]
131133
jobs:
132134
lint:

0 commit comments

Comments
 (0)