ci(yamllint): add YAML linting (#838) #838
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #838 +/- ##
=======================================
Coverage 31.06% 31.06%
=======================================
Files 26 26
Lines 2488 2488
=======================================
Hits 773 773
Misses 1715 1715 |
jlemesh
added a commit
to jlemesh/reana
that referenced
this pull request
Oct 10, 2024
jlemesh
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
e2b0493
to
788d644
Compare
tiborsimko
reviewed
Oct 10, 2024
jlemesh
changed the title
jlemesh
added a commit
to jlemesh/reana
that referenced
this pull request
Oct 15, 2024
jlemesh
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
788d644
to
97b0a62
Compare
jlemesh
added a commit
to jlemesh/reana
that referenced
this pull request
Oct 15, 2024
jlemesh
added a commit
to jlemesh/reana
that referenced
this pull request
Oct 17, 2024
jlemesh
added a commit
to jlemesh/reana
that referenced
this pull request
Oct 18, 2024
jlemesh
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
521553e
to
d4df666
Compare
tiborsimko
reviewed
Nov 13, 2024
.editorconfig
Outdated
| [Dockerfile] | ||
| indent_size = 4 | ||
|
|
||
| [*.md] |
There was a problem hiding this comment.
I'll take out the editorconfig because some of the values are not compatible with prettier etc code formatters. I'll introduce prettier style checks later on.
run-tests.sh
Outdated
| } | ||
|
|
||
| check_markdownlint () { | ||
| markdownlint-cli2 . |
There was a problem hiding this comment.
Better say markdownlint-cli2 "**/*.md" here which will catch more files.
.markdownlint.yaml
Outdated
| # MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md | ||
| MD013: false | ||
|
|
||
| # MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md037.md |
There was a problem hiding this comment.
Some of these checks are not necessary as they would catch only a handful of cases. I'll amend the sources and remove them and repush.
tiborsimko
pushed a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
Co-authored-by: Tibor Šimko <[email protected]>
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
d4df666
to
a808a4e
Compare
tiborsimko
pushed a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
Closes reanahub#836 Co-authored-by: Tibor Šimko <[email protected]>
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
Also adds basic `.editorconfig` configuration for various languages since this is the primary way how to configure `shfmt` shell script source code formatting with respect to indentation. Closes reanahub#836
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
a808a4e
to
df67510
Compare
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
Also adds basic `.editorconfig` configuration for various languages since this is the primary way how to configure `shfmt` shell script source code formatting with respect to indentation. Closes reanahub#836
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
df67510
to
8e3c97e
Compare
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 13, 2024
Also adds basic `.editorconfig` configuration for various languages since this is the primary way how to configure `shfmt` shell script source code formatting with respect to indentation. Closes reanahub#836
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
4 times, most recently
from
da20d10
to
43f8cb1
Compare
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
43f8cb1
to
227cd30
Compare
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
Closes reanahub#836 Co-authored-by: Tibor Šimko <[email protected]>
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
Also adds basic `.editorconfig` configuration for various languages since this is the primary way how to configure `shfmt` shell script source code formatting with respect to indentation. Closes reanahub#836
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
227cd30
to
47ffab1
Compare
Closes reanahub#836 Co-authored-by: Tibor Šimko <[email protected]>
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
Also adds basic `.editorconfig` configuration for various languages since this is the primary way how to configure `shfmt` shell script source code formatting with respect to indentation. Closes reanahub#836
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
47ffab1
to
514412e
Compare
Also adds basic `.editorconfig` configuration for various languages since this is the primary way how to configure `shfmt` shell script source code formatting with respect to indentation. Closes reanahub#836
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
514412e
to
8f4c9ff
Compare
tiborsimko
added a commit
to jlemesh/reana
that referenced
this pull request
Nov 14, 2024
In addition to adding JSON linting, orders all the GitHub CI checks alphabetically. Closes reanahub#836
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
8f4c9ff
to
456fae3
Compare
In addition to adding JSON linting, this commit orders all GitHub CI checks alphabetically. Closes reanahub#836
tiborsimko
force-pushed
the
feature_add_yaml_and_md_linting
branch
from
456fae3
to
430e2e4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #836
Add YAML linting for all files except Helm chart files, which are linted by
helm lintandct lint(yamllintdoes not understand templating language and fails with invalid syntax errors).Updatevalues-dev.yamlfile to pass linter checks.Add
.editorconfigfile 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.