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

chore(workflows): add editorconfig-checker #2849

Merged
merged 4 commits into from
Aug 13, 2024

Conversation

homksei
Copy link
Collaborator

@homksei homksei commented Jul 16, 2024

Description

This Pull Request adds an editorconfig-checker to CI pipeline.

Changes

  • In ci.yml the job previously known as ClangFormat has been renamed to FormattersChecks to better reflect the expanded scope of formatting checks.
  • editorconfig-checker has been added to the list of checks. This tool will verify that all submitted code follows the rules specified in .editorconfig file.
  • The .editorconfig file has been added with the following configurations to maintain code quality and consistency across different file types including Python, Perl, C, C++, Java, and Fortran among others (max_line_length temporary disabled):
root = true

[*.{py,pl,pm,i,inc,c,cpp,h,hpp,s,f,f77,f90,fi,java}]
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true
# max_line_length = 150

In case an error is found, the log will look like this:
image

@homksei homksei marked this pull request as ready for review July 16, 2024 21:28
@homksei homksei marked this pull request as draft July 16, 2024 21:28
@homksei homksei marked this pull request as ready for review July 16, 2024 21:36
@homksei homksei force-pushed the chore-editorconfig-checker branch 3 times, most recently from e86252a to b944ea7 Compare July 16, 2024 22:17
# limitations under the License.
#===============================================================================

VERSION=v3.0.3
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a way to set it as automatically updatable version? through automatic tool updates?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

have updated renovate.json config for this purpose: fe85bbe

@napetrov
Copy link
Contributor

Can we also add short readme on this check and how to run it?
this would be usefull for contributors to know how to run this

@homksei
Copy link
Collaborator Author

homksei commented Jul 25, 2024

Can we also add short readme on this check and how to run it? this would be usefull for contributors to know how to run this

Updated CONTRIBUTING.md: 49d4fb1

@homksei homksei force-pushed the chore-editorconfig-checker branch from 9b4be87 to fe85bbe Compare July 25, 2024 10:09
Copy link
Contributor

@ethanglaser ethanglaser left a comment

Choose a reason for hiding this comment

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

LGTM, only comment is that we have many files in root dir of OneDAL and its a bit cluttered. Might be worth doing a little reorganization. Not in the scope of this PR but could look eventually.

.ci/pipeline/ci.yml Outdated Show resolved Hide resolved
@homksei
Copy link
Collaborator Author

homksei commented Aug 1, 2024

LGTM, only comment is that we have many files in root dir of OneDAL and its a bit cluttered. Might be worth doing a little reorganization. Not in the scope of this PR but could look eventually.

Could you please clarify if you mean the presence of dotfiles in the root directory? It's common practice to keep these configuration files at the root level.

@napetrov
Copy link
Contributor

napetrov commented Aug 1, 2024

should we integrate this?

Copy link
Contributor

@bdmoore1 bdmoore1 left a comment

Choose a reason for hiding this comment

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

Fix broken link.

CONTRIBUTING.md Show resolved Hide resolved
@homksei homksei merged commit d270077 into oneapi-src:main Aug 13, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants