Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.7 KB

check-general-formatting-task.md

File metadata and controls

57 lines (36 loc) · 2.7 KB

"Check General Formatting" workflow (task)

Workflow file: check-general-formatting-task.yml

Use editorconfig-checker to check if the formatting of the repository's files match the .editorconfig.

Assets

  • .editorconfig
    • Install to: repository root
  • [Taskfile.yml](assets/check-general-formatting-task/Taskfile.yml] - formatting check task.
    • Install to: repository root (or add the general:check-formatting task into the existing Taskfile.yml)
  • .ecrc - editorconfig-checker configuration file.

The formatting style defined in .editorconfig is the official standardized style to be used in all Arduino tooling projects and should not be modified.

Configuration

General formatting settings are configured in the .editorconfig file. The standardized .editorconfig should be used in all Arduino Tooling repositories.

editorconfig-checker can be configured via an .ecrc file: https://github.com/editorconfig-checker/editorconfig-checker#configuration

Readme badge

Markdown badge:

[![Check General Formatting status](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-general-formatting-task.yml/badge.svg)](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-general-formatting-task.yml)

Replace the REPO_OWNER and REPO_NAME placeholders in the URLs with the final repository owner and name (example).

Asciidoc badge:

image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-general-formatting-task.yml/badge.svg["Check General Formatting status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-general-formatting-task.yml"]

Define the {repository-owner} and {repository-name} attributes and use them throughout the readme (example).

Commit message

Add CI workflow to check general file formatting

On every push, pull request, and periodically, check whether the repository's files are formatted according to
.editorconfig.

PR message

On every push, pull request, and periodically, use [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) check whether the repository's files are formatted according to [`.editorconfig`](https://editorconfig.org/).