dprint / check

GitHub action for running `dprint check`.

dprint check action

This action runs dprint check on your source code and fails the build if something is not properly formatted.

Usage

1. Checkout your repo.
2. Run dprint/check action.

jobs:
  style:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: dprint/[email protected]

If you are using a matrix, most likely you will only want to run it only on Linux. For example:

- uses: dprint/[email protected]
  if: runner.os == 'Linux'

Latest Version

By default, dprint/check uses the latest version of dprint.

Specific Version

To use a specific version, specify that with the dprint-version input:

- uses: dprint/[email protected]
  with:
    dprint-version: 0.30.3

Config Path

By default, dprint/check uses the auto-discovered configuration file.

Specific Config

To use a specific config, specify that with the config-path input:

- uses: dprint/[email protected]
  with:
    config-path: dprint-ci.json

Troubleshooting

Windows line endings

When running on Windows, you may get a lot of messages like:

from D:\a\check\check\README.md:
 | Text differed by line endings.
--

This is because unfortunately git is configured in GH actions to check out line endings as CRLF (\r\n).

You can fix this by only running the action on Linux as shown above (recommended), or to do the following before checking out the repo:

- name: Ensure LF line endings for Windows
  run: |
    git config --global core.autocrlf false
    git config --global core.eol lf

- uses: actions/checkout@v3