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

ci(yamllint): add YAML linting (#838) #838

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

jlemesh
Copy link
Member

@jlemesh jlemesh commented Oct 10, 2024

Related to #836

Add YAML linting for all files except Helm chart files, which are linted by helm lint and ct lint (yamllint does not understand templating language and fails with invalid syntax errors).Update values-dev.yaml file to pass linter checks.

Add .editorconfig file with rules for various files. Adding also .go as I remember we were talking that it would be good if the file could be used everywhere, we'll be able to copypaste it to other repositories and there will be no need for changes if new files are introduced to the repository. Let me know if it is better to only add config only for the files that currently exist in the repository.

For markdownlint, some rules were disabled because there will be to many changes to existing files (e. g. line length). Some rules do not work due to some specific contents in files, e. g. we have cron schedule defined (* * * * *) and markdownlint thinks this is emphasis (bold) and throws warning that there is a space between emphasis asterisks.

Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.80%. Comparing base (0c0849d) to head (d4df666).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #838   +/-   ##
=======================================
  Coverage   29.80%   29.80%           
=======================================
  Files          26       26           
  Lines        2486     2486           
=======================================
  Hits          741      741           
  Misses       1745     1745           

jlemesh added a commit to jlemesh/reana that referenced this pull request Oct 10, 2024
@jlemesh jlemesh force-pushed the feature_add_yaml_and_md_linting branch from e2b0493 to 788d644 Compare October 10, 2024 12:41
.editorconfig Outdated Show resolved Hide resolved
@jlemesh jlemesh changed the title ci(yamllint): add YAML linting (#836) ci(yamllint): add YAML linting (#838) Oct 15, 2024
@jlemesh jlemesh force-pushed the feature_add_yaml_and_md_linting branch from 788d644 to 97b0a62 Compare October 15, 2024 14:58
jlemesh added a commit to jlemesh/reana that referenced this pull request Oct 17, 2024
@jlemesh jlemesh force-pushed the feature_add_yaml_and_md_linting branch from 521553e to d4df666 Compare October 18, 2024 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants