Skip to content
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

[repo] Add linting of yml/yaml files in CI #1688

Closed
CodeBlanch opened this issue Apr 24, 2024 · 2 comments · Fixed by #1933
Closed

[repo] Add linting of yml/yaml files in CI #1688

CodeBlanch opened this issue Apr 24, 2024 · 2 comments · Fixed by #1933
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed infra Infra work - CI/CD, code coverage, linters

Comments

@CodeBlanch
Copy link
Member

We ran into an issue where a typo in a yml file (09cafa5) broke all code coverage upload.

I did a quick scan of GitHub marketplace, there seem to be some YML linters available. We should add linting of yml/yaml files into the CI.

High level we need to add a bucket for these files here:

yml: [ '**.yml, '**.yaml' ]

And then add a step for yml changes which calls some workflow to run linting. Similar to this...

lint-md:
needs: detect-changes
if: |
contains(needs.detect-changes.outputs.changes, 'md')
|| contains(needs.detect-changes.outputs.changes, 'build')
uses: ./.github/workflows/markdownlint.yml

@CodeBlanch CodeBlanch added good first issue Good for newcomers help wanted Extra attention is needed infra Infra work - CI/CD, code coverage, linters labels Apr 24, 2024
@mowies
Copy link
Member

mowies commented Jun 20, 2024

Hi!
I'd like to work on this :)
Any recommendations on what YAML linter to use here? Otherwise i'll look through some other OTel repos and check out what they are using.

@CodeBlanch
Copy link
Member Author

Thanks @mowies I assigned the issue to you. I have no idea what to use 🤣 Checking the other repos around OTel sounds like a great idea to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed infra Infra work - CI/CD, code coverage, linters
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants