-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(ci): add yaml linter workflow and fix yaml formatting #98
Conversation
df05a9b
to
e41a3e3
Compare
paths: | ||
- "**/*.yml" | ||
- "**/*.yaml" | ||
- ".github/workflows/yml.yml" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Out of interest, why are these two explicitly required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just so the (non required) workflow only triggers when modifying .yml/.yaml files. I suppose the workflow is yml too, so no need to specify it, but I really added it out of habit without thinking this through 😄 Although thinking about it, it might be worth leaving it in case someone copies the workflow (i.e. to make a markdown one) so he/she doesn't forget to have a trigger file path on the workflow file itself.
.golangci.yml
Outdated
template-path: .libevm-header | ||
|
||
gomodguard: | ||
blocked: | ||
modules: | ||
- github.com/ethereum/go-ethereum: | ||
reason: "" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting! How did it know that these fields exist?! I've made suggestions with reasons so my original rationale is now explicit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It didn't, I looked it up because the linter was complaining about the empty object, i.e.
- blabla:
- abc:
is not making the linter happy, so I've set just one field to its zero value 🤷 But good you've added a reason for each, even better 👍
- triggers only on yaml/yml file modifications - uses built-in yamllint with yamllint.yml configuration
Co-authored-by: Arran Schlosberg <[email protected]> Signed-off-by: Quentin McGaw <[email protected]>
Co-authored-by: Arran Schlosberg <[email protected]> Signed-off-by: Quentin McGaw <[email protected]>
Co-authored-by: Arran Schlosberg <[email protected]> Signed-off-by: Quentin McGaw <[email protected]>
Co-authored-by: Arran Schlosberg <[email protected]> Signed-off-by: Quentin McGaw <[email protected]>
Co-authored-by: Arran Schlosberg <[email protected]> Signed-off-by: Quentin McGaw <[email protected]>
66acc12
to
d9d59a1
Compare
d9d59a1
to
a4b5f69
Compare
Why this should be merged
To have consistent, warning-free yaml files, enforced by the CI
How this works
How this was tested
New CI job passing