Skip to content

ci(linting): add remaining linting and formatting checks #231

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

Merged
merged 5 commits into from
Jul 24, 2025

Conversation

CameronMcClymont
Copy link
Member

Introduce remaining file formatting checks to run-tests.sh and to the GitHub CI:

  • .editorconfig for consistent character formatting across the repo
  • yamllint for YAML linting
  • jsonlint for JSON linting
  • shfmt for shell script formatting
  • markdownlint for markdown linting
  • prettier for various other formatting such as .js files

Closes #230

Copy link

codecov bot commented Jul 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.65%. Comparing base (f32aafd) to head (acb707f).
Report is 5 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #231   +/-   ##
=======================================
  Coverage   27.65%   27.65%           
=======================================
  Files           5        5           
  Lines         141      141           
=======================================
  Hits           39       39           
  Misses        102      102           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 17, 2025
@CameronMcClymont CameronMcClymont moved this to In review in 0.95.0 Jul 17, 2025
Copy link
Member

@tiborsimko tiborsimko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having introduces everything in one single commit, instead of adding each linter/formatter separately, may be acceptable -- but then we would have to alter the commit log headline message in order to produce nicer release news item for users. (Because people would not understand "add remaining linting and formatting checks" -- which remaning?) One possibility would be to write something like "add JSON, Markdown, Prettier, shmft, YAML formatting and linting" if it is not too long.

Alternatively, you can just split the commit into several dedicated atomic ones, starting with shfmt, as yet another git rebasing exercise...

See an example of such automatically generated release notes: reanahub/reana-workflow-controller#578

@@ -0,0 +1,4 @@
# Allow prompt dollar sign in console examples without showing output
MD014: false
# Allow multiple headings with same content (for different releases)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cosmetics: Let's use a blank line between these two rules?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, understood. I'll see if it's difficult to split the commits.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems doable splitting the commits, I might not get round to all of them today

CHANGELOG.md Outdated
# Changelog

## [0.9.4](https://github.com/reanahub/reana-workflow-engine-serial/compare/0.9.3...0.9.4) (2024-11-29)


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder whether Release Please will reintruduce empty lines when compiling next release notes. If so, then it would be better if we add another markdownlint disable statement...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes will do 👍

CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 23, 2025
CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 23, 2025
CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 23, 2025
CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 23, 2025
CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 23, 2025
CameronMcClymont added a commit to CameronMcClymont/reana-workflow-engine-serial that referenced this pull request Jul 23, 2025
@tiborsimko tiborsimko force-pushed the add-remaining-linting branch from 29202fc to acb707f Compare July 24, 2025 13:24
Copy link
Member

@tiborsimko tiborsimko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, slightly amended the commit log headlines for nicer release notes.

@tiborsimko tiborsimko merged commit acb707f into reanahub:master Jul 24, 2025
19 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in 0.95.0 Jul 24, 2025
@CameronMcClymont CameronMcClymont deleted the add-remaining-linting branch July 28, 2025 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

ci: add remaining linting
2 participants