Skip to content

Commit

Permalink
chore(doc): update examples to include name for action
Browse files Browse the repository at this point in the history
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 #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.
  • Loading branch information
pfeerick authored Jul 10, 2024
1 parent 0d29e84 commit 4b64335
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ GitHub access token used to get information from the GitHub API.
The minimal workflow to run the default checks on the projects in the repository:

```yaml
name: arduino-lint
on: [push, pull_request]
jobs:
lint:
Expand All @@ -127,6 +128,7 @@ jobs:
A more complex workflow which uses [inputs](#inputs) to configure the action for Library Manager ["update" mode](#library-manager) and strict compliance:
```yaml
name: arduino-lint
on: [push, pull_request]
jobs:
lint:
Expand Down

0 comments on commit 4b64335

Please sign in to comment.