使用 Github 操作验证 .editorconfig 文件

Question

我想确保我的 Github 存储库中的任何拉取请求都遵循 .editorconfig（ASp.NET Core 5 C# 项目）中定义的规则。我发现 https://github.com/github/super-linter 使用

来检查代码

我在工作流程中添加了以下 linter.yml 文件，

---
###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: Lint Code Base

#
# Documentation:
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
#

#############################
# Start the job on all push #
#############################
on:
    push:
    branches-ignore: [main]
    # Remove the line above to run when pushing to main
    pull_request:
    branches: [main]

###############
# Set the Job #
###############
jobs:
    build:
    # Name the Job
    name: Lint Code Base
    # Set the agent to run on
    runs-on: ubuntu-latest

    ##################
    # Load all steps #
    ##################
    steps:
        ##########################
        # Checkout the code base #
        ##########################
        - name: Checkout Code
        uses: actions/checkout@v2
        with:
            # Full git history is needed to get a proper list of changed files within `super-linter`
            fetch-depth: 0

        ################################
        # Run Linter against codebase #
        ################################
        - name: Lint Code Base
        uses: github/super-linter@v4
        env:
            VALIDATE_ALL_CODEBASE: false
            DEFAULT_BRANCH: main
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

它成功了，但我没有看到它正在验证 Github 存储库根目录中的 .editorconfig 规则？我错过了什么吗？

Answer 1

检查 Super Linter Github 操作中的 Environment Variables，EDITORCONFIG_FILE_NAME 文件的默认值为 .ecrc .

因此，如果您的文件名是 .editorconfig，您必须将其添加到 操作参数列表 ，如：

- name: Lint Code Base
  uses: github/super-linter@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: main
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    EDITORCONFIG_FILE_NAME: .editorconfig

识别此文件后，Super Linter 操作将使用 editorconfig-checker 存储库对其进行检查。

编辑： 根据评论，super linter 使用的 dotnet-format 也会自动使用 .editorconf 文件。如果你想使用这个 linter 检查它，不需要设置 EDITORCONFIG_FILE_NAME。只有，设置VALIDATE_CSHARP: true

使用 Github 操作验证 .editorconfig 文件

Validate .editorconfig file using Github Action

.net

c#

continuous-integration

editorconfig

github-actions