Skip to content

Commit

Permalink
chore(workflows): add editorconfig-checker (#2849)
Browse files Browse the repository at this point in the history
  • Loading branch information
homksei authored Aug 13, 2024
1 parent e983f90 commit d270077
Show file tree
Hide file tree
Showing 6 changed files with 94 additions and 10 deletions.
32 changes: 32 additions & 0 deletions .ci/env/editorconfig-checker.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/bin/bash
#===============================================================================
# Copyright contributors to the oneDAL project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#===============================================================================

VERSION=v3.0.3
NAME=ec-linux-amd64
ASSET=$NAME.tar.gz

# Download
export SHA256="fc698b0bf5bca0d42e28dd59d72e25487a51f645ca242c5f74bae975369f16aa $ASSET"
wget https://github.com/editorconfig-checker/editorconfig-checker/releases/download/$VERSION/$ASSET
echo "${SHA256}" | sha256sum --check

# Install
tar -xzf $ASSET
mv bin/$NAME /usr/local/bin/editorconfig-checker

# Clean up the downloaded archive
rm $ASSET
9 changes: 7 additions & 2 deletions .ci/pipeline/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,22 @@ variables:
SYSROOT_OS: 'jammy'

jobs:
- job: 'ClangFormat'
- job: 'FormatterChecks'
pool:
vmImage: '$(VM_IMAGE)'
steps:
- script: |
.ci/env/apt.sh clang-format
displayName: 'apt-get'
.ci/env/editorconfig-checker.sh
displayName: 'Install Dependencies'
- script: |
.ci/scripts/clang-format.sh
displayName: 'clang-format check'
failOnStderr: true
- script: |
editorconfig-checker
displayName: 'editorconfig-checker'
failOnStderr: true
- job: 'LinuxMakeGNU_MKL'
timeoutInMinutes: 0
Expand Down
17 changes: 17 additions & 0 deletions .ecrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"Verbose": false,
"Debug": false,
"IgnoreDefaults": false,
"SpacesAftertabs": false,
"NoColor": false,
"AllowedContentTypes": [],
"PassedFiles": [],
"Disable": {
"EndOfLine": false,
"Indentation": false,
"InsertFinalNewline": false,
"TrimTrailingWhitespace": false,
"IndentSize": true,
"MaxLineLength": false
}
}
7 changes: 7 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
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
23 changes: 16 additions & 7 deletions .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,24 @@
},
"packageRules": [
{
"groupName": "Doc packages",
"matchUpdateTypes": ["patch", "minor"],
"schedule": ["before 2am on the first day of the month"],
"matchFileNames": ["docs/requirements.txt"]
"groupName": "Doc packages",
"matchUpdateTypes": ["patch", "minor"],
"schedule": ["before 2am on the first day of the month"],
"matchFileNames": ["docs/requirements.txt"]
},
{
"groupName": "Dockerfile",
"schedule": ["before 2am on the first day of the month"],
"matchFileNames": ["**/*.Dockerfile"]
"groupName": "Dockerfile",
"schedule": ["before 2am on the first day of the month"],
"matchFileNames": ["**/*.Dockerfile"]
}
],
"customManagers": [
{
"customType": "regex",
"fileMatch": ["^\\.ci\\/env\\/editorconfig-checker\\.sh$"],
"matchStrings": ["VERSION=(?<currentValue>v\\d+\\.\\d+\\.\\d+)"],
"depNameTemplate": "editorconfig-checker/editorconfig-checker",
"datasourceTemplate": "github-releases"
}
]
}
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Refer to our guidelines on [pull requests](#pull-requests) and [issues](#issues)

## Contacting maintainers
You may reach out to Intel project maintainers privately at onedal.maintainers@intel.com.
[Codeowners](https://github.com/oneapi-src/oneDAL/blob/main/.github/CODEOWNERS) configuration defines specific maintainers for corresponding code sections, however it's currently limited to Intel members. With further migration to UXL we will be changing this, but here are non-Intel contacts:
[Codeowners](https://github.com/oneapi-src/oneDAL/blob/main/.github/CODEOWNERS) configuration defines specific maintainers for corresponding code sections, however it's currently limited to Intel members. With further migration to UXL we will be changing this, but here are non-Intel contacts:

For ARM specifics you may contact: [@rakshithgb-fujitsu](https://github.com/rakshithgb-fujitsu/)

Expand Down Expand Up @@ -65,6 +65,20 @@ clang-format style=file <your file>

Refer to [ClangFormat documentation](https://clang.llvm.org/docs/ClangFormat.html) for more information.

### editorconfig-checker

We also recommend using [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) to ensure your code adheres to the project's coding style. EditorConfig-Checker is a command-line tool that checks your code against the rules defined in the [.editorconfig](https://github.com/oneapi-src/oneDAL/blob/main/.editorconfig) file.

To use it, follow these steps:

1. Install the tool by following the instructions in the [official documentation](https://github.com/editorconfig-checker/editorconfig-checker#installation).
2. Navigate to the root directory of your project.
3. Run the following command to check your code:

```
editorconfig-checker
```

### Coding Guidelines

For your convenience we also added [coding guidelines](http://oneapi-src.github.io/oneDAL/contribution/coding_guide.html) with examples and detailed descriptions of the coding style oneDAL follows. We encourage you to consult them when writing your code.
Expand Down

0 comments on commit d270077

Please sign in to comment.