actions-marketplace-validations/dotnet-format-action

Run dotnet format and optionally apply any fixes

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
Runtime
Deprecated runtime
namedescriptionrequireddefault
repo-tokenThe GITHUB_TOKEN secretyes
actionThe primary action `dotnet format` should perform. `check` for only checking, `fix` will also actually fix the formatting errors in the files.nocheck
only-changed-filesOnly changed files in the current pull request should be formatted. Only works when the trigger is a pull request.no
fail-fastThe job should fail if there's a formatting error.notrue
workspaceThe solution or project file to operate on. In case you want to process all files in a certain folder, set the root folder here and specify the `workspaceIsFolder` option.no
workspaceIsFolderSpecifies if the value in `workspace` has to be treated as a simple folder. If true, set `workspace` to the root folder you want to process.nofalse
includeThe files to include, delimited by space. Cannot be used together with the `workspace` option.no
excludeThe files to exclude, delimited by space.no
fix-whitespaceRemoves whitespaces according to formatting rules.no
fix-analyzers-levelFixes styles from third-party analyzers. More on https://github.com/dotnet/format/blob/main/docs/3rd-party-analyzers.mdno
fix-style-levelFixes styles according to formating rules.no
logLevelSets the logging verbosity of the dotnet format process. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]no
namedescription
has-changesA value indicating if any files were formatted. If `action` is `check` we will inspect the exit code of `dotnet format` to be <> 0. If `action` is `fix` we see if there are changes to files with `git status -s`.