actually fix cs via github action about php-cs-fixer-ga

[mpdude]

Let's give it a try:

on: [push]
name: Create PRs for php-cs-fixer fixups

jobs:
    fix-cs:
        name: Fix CS violations
        runs-on: ubuntu-18.04
        steps:
            - uses: actions/checkout@v2
            - uses: docker://oskarstark/php-cs-fixer-ga:latest
            - uses: peter-evans/create-pull-request@v2
              id: cpr
              with:
                  token: ${{ secrets.GITHUB_TOKEN }}
                  commit-message: Apply php-cs-fixer changes as of ${{ github.sha }}
                  title: Fix coding standards in ${{ github.ref }}
                  branch: php-cs-fixer/${{ github.ref }}
                  assignees: ${{ github.actor }}
                  body: |
                    Please apply these changes on the ${{ github.ref }} branch to fix coding standard violations.

            - uses: unsplash/[email protected]
              env:
                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
              if: steps.cpr.outputs.pr_number
              continue-on-error: true # Will fail if not on PR
              with:
                  msg: |
                    @${{ github.actor }} please apply the coding standard fixes from #${{ steps.cpr.outputs.pr_number }}

This will monitor all pushed commits. Whenever a commit violates CS,

• create a branch named php-cs-fixer/ + the name of the branch with the bogus commits
• (force) push necessary changes there
• Open a PR, to merge that branch into the offending branch
• If the offending branch has a corresponding PR open, add a comment in it to point to the fixups

Only downside: If a branch or PR violates CS, the status checks will be green, regardless of whether a fix is necessary or not.

Update: I'll try to maintain an up-to-date version of this at https://gist.github.com/mpdude/ca93a185bcbf56eb7e341632ad4f8263

[staabm]

I guess this would be easy to achieve using https://github.com/peter-evans/create-pull-request

Might only need a example config

[staabm]

Totally I agree. This issue can be closed (it is opened from my corporate user account)

[OskarStark]

Not yet but you can run the docker command locally from the readme to fix the issues, so that you don’t need that dependency in your composer.json file

[staabm]

after using some other Github Actions as a 'end-user' it seems to me that a comment triggered action command would be best for this.

something like: when a comment is posted to a pull request which contains /fix-cs let the action run, fix the code and push to this pull request.

inspiration can be taken from e.g. https://github.com/cirrus-actions/rebase which does that with a different command.

I have no experience with docker or authoring github actions, therefore won't tackle it myself in the next weeks/months though.

[OskarStark]

Nice idea

[OskarStark]

Nice idea

[simonschaufi]

I have found this github action here that actually also fixes code style: https://github.com/christophrumpel/laravel-factories-reloaded/blob/master/.github/workflows/run-styles.yml and this blog article: https://stefanzweifel.io/posts/run-prettier-or-php-cs-fixer-with-github-actions/#run-php-cs-fixer

[staabm]

We are using something similar in the meantime
https://github.com/redaxo/redaxo/blob/master/.github/workflows/cs-fix.yml

[OskarStark]

TBH it does not feel right do add all the needed code to this repository.

@localheinz and me are using Stefan Zweifel’s GitHub Action to commit changed files afterwards. You can do so much more like using a dedicated bot 🤖 User etc.