xt0rted / dotnet-format Goto Github PK

I am seeing similar to the nothing to commit, working tree clean issue here: #10 (comment), and it does not seem to be due to line-ending settings

I made a PR, with the config file similar to given there, and also added extra spaces to a code file, so that the format would have something to fix.
The result is that it is formatted on the format step,
and this is followed by "nothing to commit, working tree clean" at the commit step

Run xt0rted/dotnet-format@v1
  with:
    repo-token: ***
    action: check
    fail-fast: true
  env:
    DOTNET_ROOT: /home/runner/.dotnet
/home/runner/.dotnet/dotnet format --check --dry-run
  The file '--dry-run' does not appear to be a valid project or solution file.
Error: Formatting issues found

https://github.com/dotnet/format#new-in-v50211103

Both a MSBuild project file and solution file found in XXX. Specify which to use with the --workspace option.

I am running dotnet format and then trying to commit and push the changes. I can see that the format step updates some files but somehow the commit step doesn't find any changes.

This is the output of the commit step:

Running in /home/runner/work/project/project
Add input parsed as single string, running 1 git add command.
> Using 'Github Actions <[email protected]>' as author.
> Using "Automated dotnet-format update" as commit message.
Internal logs
> Working tree clean. Nothing to commit.
Outputs

I don't understand how the working tree can be clear after the dotnet format step formatted 4 files.

This is my YAML:

name: Format check on pull request
on: pull_request
jobs:
  dotnet-format:
    runs-on: ubuntu-latest
    steps:
      - name: Install dotnet-format
        run: dotnet tool install -g dotnet-format --version "5.*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet7/nuget/v3/index.json

      - name: Checkout repo
        uses: actions/checkout@v2

      - name: Run dotnet format
        id: format
        uses: xt0rted/[email protected]
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          action: "fix"
          only-changed-files: false
          fail-fast: false
      
      - name: Commit files
        if: steps.format.outputs.has-changes == 'true'
        uses: EndBug/add-and-commit@v8
        with:
          author_name: Github Actions
          author_email: [email protected]
          message: Automated dotnet-format update

Any idea what I'm doing wrong?

I spent past hour or so trying to get dotnet format working in my action pipeline for a .NET Core v6 project. I went through various configurations to the yml file but all end with the same result:

Unrecognized command or argument '--check'
Unrecognized command or argument '--dry-run'
Unrecognized command or argument '--files'

Is there any workaround for this?

Not sure if I did something wrong implementing the example yaml or this is a legit bug.

Run xt0rted/[email protected]
with:
repo-token: ***
action: check
fail-fast: true
/usr/bin/dotnet format --check --dry-run
Could not execute because the specified command or file was not found.
Possible reasons for this include:

• You misspelled a built-in dotnet command.
• You intended to execute a .NET Core program, but dotnet-format does not exist.
• You intended to run a global tool, but a dotnet-prefixed executable with this name could not be found on the PATH.
  (node:2919) UnhandledPromiseRejectionWarning: Error: Formatting issues found
  at Object. (/home/runner/work/_actions/xt0rted/dotnet-format/v1.0.1/dist/index.js:1355:19)
  at Generator.next ()
  at fulfilled (/home/runner/work/_actions/xt0rted/dotnet-format/v1.0.1/dist/index.js:1335:58)
  at processTicksAndRejections (internal/process/task_queues.js:93:5)
  (node:2919) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
  (node:2919) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
  ##[error]Formatting issues found

This is likely a newbie error, but it's not documented.

When running, I get:

Run dotnet format1s
(node:2726) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
Run xt0rted/dotnet-format@v1
Checking 22 files
/usr/bin/dotnet format --check --dry-run --files BunchOfFiles

Could not execute because the specified command or file was not found.
Possible reasons for this include:
  * You misspelled a built-in dotnet command.
  * You intended to execute a .NET Core program, but dotnet-format does not exist.
  * You intended to run a global tool, but a dotnet-prefixed executable with this name could not be found on the PATH.

So it looks like this tool assumes that dotnet format is insalled. But it is not in this case. Is there a simple option to add? A place where I should add in a run: dotnet tool install -g dotnet-format ?

Note the output of the run, some deprecated options of dotnet-format are used:

Run xt0rted/dotnet-format@v1
Checking 7 files
/usr/bin/dotnet format --check --dry-run --files _somefiles_
  The `--files` option is deprecated. Use the `--include` option instead.
  The `--dry-run` option is deprecated. Use the `--check` option instead.

As you may see here, I tried to make pull requests as fixer action.

Two issues occurred,

1. It triggered a new action upon commit
2. steps.format.outputs.has-changes returns true even there is no file to commit, which causes an additional error you may find it in here

I don't want to use a comment; if the formatting is wrong, it should be fixed it right at the commit into the pull request in my case.

Node 12 is deprecated so this needs to updated to node16 and a new major version released.