GitHub Action for dotnet format

Run dotnet format as part of your workflow to report formatting errors or auto fix violations as part of your pull request workflow.

Usage

Running on pull_request, adding a commit to the PR.

Use this only when the PRs are coming from the same repository. You won't have permission to add commits to PRs coming from a forked repository.

nname: Format check on pull request
on: pull_request
jobs:
  dotnet-format:
    runs-on: windows-latest
    steps:
      - name: Setup .NET Core
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: '8.0.x'

      - name: Checkout repo
        uses: actions/checkout@v4
        with:
          ref: ${{ github.head_ref }}

      - name: Install dotnet-format
        run: dotnet tool install -g dotnet-format

      - name: Run dotnet format
        id: format
        uses: KumaranFabric/dotnet-format@6f374ab26a7ff1f31c195e69cd0f8e9a336d3fe0
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          action: "check"
          workspace: .
          workspaceIsFolder: true
          only-changed-files: true
          log-level: diag

      - name: Commit files
        if: steps.format.outputs.has-changes == 'true'
        run: |
          git config --local user.name "github-actions[bot]"
          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git commit -a -m 'Automated dotnet-format update
          Co-authored-by: ${{ github.event.pull_request.user.login }} <${{ github.event.pull_request.user.id }}+${{ github.event.pull_request.user.login }}@users.noreply.github.com>'
      - name: Push changes
        if: steps.format.outputs.has-changes == 'true'
        uses: ad-m/github-push-action@0fafdd62b84042d49ec0cb92d9cac7f7ce4ec79e
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: ${{ github.head_ref }}

Options

Required

Name	Allowed values	Description
repo-token	GITHUB_TOKEN or a custom value	The token used to call the GitHub api.

Optional

Name	Allowed values	Description
action	check (default), fix	The primary action dotnet format should perform. Check doesn't make changes to your file, fix will do the actual formatting.
only-changed-files	true, false (default)	Only changed files in the current pull request should be formatted. Only works when the trigger is a pull request.
fail-fast	true (default), false	The job should fail if there's a formatting error. Only used with the check action.
workspace	.	The 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.
workspaceIsFolder	true	Specify if the workspace should be treated as a folder.
include	.	The files to include, delimited by space. Cannot be used together with the workspace option.
exclude	.	Space delimited list of files and/or folders to ignore.
log-level	q[uiet], m[inimal], n[ormal], d[etailed], diag[nostic]	Sets the logging verbosity of the dotnet format process
fix-whitespace	true, false (default)	Removes whitespaces according to formatting rules.
fix-analyzers-level	info, warn, error	Fixes styles from third-party analyzers. More on https://github.com/dotnet/format/blob/main/docs/3rd-party-analyzers.md.
fix-style-level	info, warn, error	Fixes styles according to formating rules.

Outputs

Name	Description
has-changes	If any files were found to have violations or had fixes applied. Will be a string value of true or false.

Building from source

Generating dist/index.js

npm run release

Limitations

Currently seems to only work under windows-latest container. Also some other issues: dotnet/format#1378 dotnet/format#1479 dotnet/format#757

License

The scripts and documentation in this project are released under the MIT License

Acknowledgements

Thank you @eero-dev, @victor-alcazar, @xt0rted and @jfversluis for the first versions that I have forked this from