Failing the job if a change is detected - Githubissues

stefanzweifel / git-auto-commit-action

Automatically commit and push changed files back to GitHub with this GitHub Action for the 80% use case.

MIT License

2.06k stars 231 forks source link

Failing the job if a change is detected #214

Closed lukepighetti closed 2 years ago

lukepighetti commented 2 years ago

I've been discussing with a colleague if the best practice with committing changed code to a PR branch (such as formatted / generated code) is to have the action fail or succeed. I was wondering if you would comment on this.

Arguments for success

The action technically did succeed
It's easier to implement, as this is the default behavior

Arguments for fail

The action succeeded only because the codebase was in a failing state (code out of date, needed to be updated)
Failing will block an automerge, and you want a chance for the checks to run on the subsequent PR