-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Problem
The README contains invalid YAML syntax in the usage example that will cause workflow failures for users who copy it.
Current code (README.md:15):
on:
- push:This is invalid YAML. The on: trigger should not use a list format with a dash when specifying event configuration.
Solution
Choose one of these valid formats:
Option 1 - Simple trigger (recommended):
on:
push:Option 2 - Multiple events:
on: [push, pull_request]Option 3 - List format (if using multiple events):
on:
- push
- pull_requestImpact
Users copying the README example will encounter workflow syntax errors. This should be fixed before v1.0.0 release to ensure good first-user experience.
References
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation