Chore: Added Github Action to auto format code on push to main

[jay-dee7]

This PR adds a Github Action to auto-format code using gofumpt on push to master.

Fixes #93

Signed-off-by: jay-dee7 jasdeepsingh.uppal@gmail.com

[mfridman]

Thanks for the PR, but I'd prefer not introducing a 3rd party github action for formatting.

[jay-dee7]

Hey @mfridman does that mean the regular goimports or go fmt would be preferred here?

[mfridman]

Ye, most projects I've seen have linting, formatting, etc. run against the pull request itself. If there is a diff or something doesn't match it is up to the author to fix (CI fails).

I don't have a strong opinion on whether to use gofmt or gofumpt. The latter has pre-built binaries so can curl it.

Something like this can be added before the tests:

- name: Check Go code formatting
  run: |
    if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then
      gofmt -s -l .
      echo "Please format Go code by running: go fmt ./..."
      exit 1
    fi

This avoids a dependency on a GitHub Action and enforces standard PR's to make reviews easier. What do you think?

[jay-dee7]

I think the CI failing actually is the way go. I have it failing on all of my other projects. Usually author is responsible to fix them. I'll go ahead and make the PR changes :)

[oxisto]

Closed in favour of #206